project

type AccessSource string

type AccessToken string

type AuditLogEntry struct {
	CreatedAt   time.Time
	Info        interface{}
	InitiatorId sharedTypes.UUID
	Operation   string
}

type AuthorizationDetails struct {
	Epoch          int64                      `json:"e"`
	PrivilegeLevel sharedTypes.PrivilegeLevel `json:"l"`
	AccessSource   AccessSource               `json:"s"`
}

type CommonTreeFields struct {
	Id        sharedTypes.UUID     `json:"_id"`
	Name      sharedTypes.Filename `json:"name"`
	CreatedAt time.Time            `json:"created"`
}

type CompilerField struct {
	Compiler sharedTypes.Compiler `json:"compiler"`
}

type ContentLockedAtField struct {
	ContentLockedAt *time.Time `json:"contentLockedAt"`
}

type CreatedAtField struct {
	CreatedAt time.Time
}

type DeletedAtField struct {
	DeletedAt time.Time
}

type DeletedDocsField struct {
	DeletedDocs []CommonTreeFields `json:"deletedDocs"`
}

type Doc struct {
	LeafFields
	Snapshot string              `json:"snapshot"`
	Version  sharedTypes.Version `json:"version"`
}

type DocWithParent struct {
	Doc
	Parent IdField
}

type DocsField struct {
	Docs []Doc
}

type EditableField struct {
	Editable bool `json:"editable"`
}

type EpochField struct {
	Epoch int64
}

type FileRef struct {
	LeafFields

	LinkedFileData *LinkedFileData  `json:"linkedFileData,omitempty"`
	Hash           sharedTypes.Hash `json:"hash,omitempty"`
	Size           int64            `json:"size"`
}

type FileWithParent struct {
	FileRef
	ParentId sharedTypes.UUID
}

type FilesField struct {
	Files []FileRef
}

type Folder struct {
	CommonTreeFields
	Path sharedTypes.DirName `json:"-"`

	Docs     []Doc     `json:"docs"`
	FileRefs []FileRef `json:"fileRefs"`
	Folders  []Folder  `json:"folders"`
}

type FoldersField struct {
	Folders []Folder `json:"-"`
}

type ForAuthorizationDetails struct {
	Member
	EpochField
	PublicAccessLevelField
	TokensField
}

type ForBootstrapWS struct {
	ForTree `json:"-"`

	CompilerField
	ContentLockedAtField
	EditableField
	DeletedDocsField
	IdField
	ImageNameField
	NameField
	OwnerField
	PublicAccessLevelField
	RootDocIdField
	SpellCheckLanguageField
	VersionField
}

type ForClone struct {
	ForAuthorizationDetails
	CompilerField
	ImageNameField
	RootDocField
	SpellCheckLanguageField
	ForTree
}

type ForCreation struct {
	CreatedAtField
	CompilerField
	DeletedAtField
	IdField
	ImageNameField
	NameField
	OwnerIdField
	RootDocField
	SpellCheckLanguageField
	RootFolderField
}

type ForProjectEntries struct {
	DocsField
	FilesField
}

type ForProjectInvite struct {
	NameField
	ForAuthorizationDetails

	Sender user.WithPublicInfo
	User   user.WithPublicInfo
}

type ForProjectJWT struct {
	ForAuthorizationDetails
	EditableField
	OwnerFeaturesField
}

type ForProjectList struct {
	User          user.ProjectListViewCaller
	Tags          []tag.Full
	Notifications notification.Notifications
	Projects      List
}

type ForTokenAccessDetails struct {
	IdField
	NameField
	ForAuthorizationDetails
}

type ForTree struct {
	RootFolderField
	// contains filtered or unexported fields
}

type ForZip struct {
	NameField
	ForTree
}

type IdField struct {
	Id sharedTypes.UUID `json:"_id"`
}

type ImageNameField struct {
	ImageName sharedTypes.ImageName `json:"imageName"`
}

type IsRestrictedUser bool

type LastOpenedField struct {
	LastOpened time.Time
}

type LastUpdatedAtField struct {
	LastUpdatedAt time.Time
}

type LastUpdatedByField struct {
	LastUpdatedBy sharedTypes.UUID
}

type LeafFields struct {
	CommonTreeFields
	Path sharedTypes.PathName `json:"-"`
}

type LinkedFileData struct {
	Provider             LinkedFileProvider   `json:"provider"`
	SourceProjectId      sharedTypes.UUID     `json:"source_project_id,omitempty"`
	SourceEntityPath     sharedTypes.PathName `json:"source_entity_path,omitempty"`
	SourceOutputFilePath sharedTypes.PathName `json:"source_output_file_path,omitempty"`
	URL                  string               `json:"url,omitempty"`
}

type LinkedFileProvider string

type List []ListViewPrivate

type ListViewPrivate struct {
	ContentLockedAtField
	ForAuthorizationDetails
	IdField
	LastUpdatedAtField
	LastUpdatedByField
	NameField
	OwnerIdField

	LastUpdater user.WithPublicInfoAndNonStandardId
	Owner       user.WithPublicInfoAndNonStandardId
	TagIds      sharedTypes.UUIDs
}

type LoadEditorDetails struct {
	Project LoadEditorViewPrivate
	User    user.WithLoadEditorInfo
}

type LoadEditorViewPrivate struct {
	LoadEditorViewPublic
	ForAuthorizationDetails
	EditableField
	RootDocField
}

type LoadEditorViewPublic struct {
	CompilerField
	IdField
	ImageNameField
	NameField
	OwnerFeaturesField
	RootDocIdField
	VersionField
}

type Manager interface {
	PrepareProjectCreation(ctx context.Context, p *ForCreation) error
	FinalizeProjectCreation(ctx context.Context, p *ForCreation) error
	SoftDelete(ctx context.Context, projectIds sharedTypes.UUIDs, userId sharedTypes.UUID, ipAddress string) error
	HardDelete(ctx context.Context, projectId sharedTypes.UUID) error
	ProcessSoftDeleted(ctx context.Context, cutOff time.Time, fn func(projectId sharedTypes.UUID) bool) error
	GetDeletedProjectsName(ctx context.Context, projectId, userId sharedTypes.UUID) (Name, error)
	Restore(ctx context.Context, projectId, userId sharedTypes.UUID, name Name) error
	AddFolder(ctx context.Context, projectId, userId, parent sharedTypes.UUID, f *Folder) (sharedTypes.Version, error)
	DeleteDoc(ctx context.Context, projectId, userId, docId sharedTypes.UUID) (sharedTypes.Version, error)
	DeleteFile(ctx context.Context, projectId, userId, fileId sharedTypes.UUID) (sharedTypes.Version, error)
	DeleteFolder(ctx context.Context, projectId, userId, folderId sharedTypes.UUID) (sharedTypes.Version, error)
	RestoreDoc(ctx context.Context, projectId, userId, docId sharedTypes.UUID, name sharedTypes.Filename) (sharedTypes.Version, sharedTypes.UUID, error)
	MoveDoc(ctx context.Context, projectId, userId, folderId, docId sharedTypes.UUID) (sharedTypes.Version, sharedTypes.PathName, error)
	MoveFile(ctx context.Context, projectId, userId, folderId, fileId sharedTypes.UUID) (sharedTypes.Version, sharedTypes.PathName, error)
	MoveFolder(ctx context.Context, projectId, userId, targetFolderId, folderId sharedTypes.UUID) (sharedTypes.Version, []Doc, []FileRef, error)
	RenameDoc(ctx context.Context, projectId, userId sharedTypes.UUID, d *Doc) (sharedTypes.Version, sharedTypes.PathName, error)
	RenameFile(ctx context.Context, projectId, userId sharedTypes.UUID, f *FileRef) (sharedTypes.Version, sharedTypes.PathName, error)
	RenameFolder(ctx context.Context, projectId, userId sharedTypes.UUID, f *Folder) (sharedTypes.Version, []Doc, []FileRef, error)
	GetAuthorizationDetails(ctx context.Context, projectId, userId sharedTypes.UUID, accessToken AccessToken) (*AuthorizationDetails, error)
	GetForClone(ctx context.Context, projectId, userId sharedTypes.UUID) (*ForClone, error)
	GetForProjectInvite(ctx context.Context, projectId, actorId sharedTypes.UUID, email sharedTypes.Email) (*ForProjectInvite, error)
	GetForProjectJWT(ctx context.Context, projectId, userId sharedTypes.UUID, accessToken AccessToken) (*ForProjectJWT, int64, error)
	GetForZip(ctx context.Context, projectId sharedTypes.UUID, userId sharedTypes.UUID, accessToken AccessToken) (*ForZip, error)
	ValidateProjectJWTEpochs(ctx context.Context, projectId, userId sharedTypes.UUID, projectEpoch, userEpoch int64) error
	BumpLastOpened(ctx context.Context, projectId sharedTypes.UUID) error
	GetDoc(ctx context.Context, projectId, docId sharedTypes.UUID) (*time.Time, *Doc, error)
	GetFile(ctx context.Context, projectId, userId sharedTypes.UUID, accessToken AccessToken, fileId sharedTypes.UUID) (*FileWithParent, error)
	GetElementByPath(ctx context.Context, projectId, userId sharedTypes.UUID, path sharedTypes.PathName) (sharedTypes.UUID, bool, error)
	GetBootstrapWSDetails(ctx context.Context, projectId, userId sharedTypes.UUID, projectEpoch, userEpoch int64, source AccessSource, p *ForBootstrapWS, u *user.WithPublicInfo) error
	GetBootstrapWSUser(ctx context.Context, projectId, userId sharedTypes.UUID, projectEpoch, userEpoch int64, u *user.WithPublicInfo, treeVersion *sharedTypes.Version) error
	GetLastUpdatedAt(ctx context.Context, projectId sharedTypes.UUID) (time.Time, error)
	GetLoadEditorDetails(ctx context.Context, projectId, userId sharedTypes.UUID, accessToken AccessToken) (*LoadEditorDetails, error)
	GetProjectWithContent(ctx context.Context, projectId sharedTypes.UUID) ([]Doc, []FileRef, error)
	GetTokenAccessDetails(ctx context.Context, userId sharedTypes.UUID, privilegeLevel sharedTypes.PrivilegeLevel, accessToken AccessToken) (*ForTokenAccessDetails, *AuthorizationDetails, error)
	GetTreeEntities(ctx context.Context, projectId, userId sharedTypes.UUID) ([]TreeEntity, error)
	GetProjectMembers(ctx context.Context, projectId sharedTypes.UUID) ([]user.AsProjectMember, error)
	GrantTokenAccess(ctx context.Context, projectId, userId sharedTypes.UUID, accessToken AccessToken, privilegeLevel sharedTypes.PrivilegeLevel) error
	GrantMemberAccess(ctx context.Context, projectId, ownerId, userId sharedTypes.UUID, privilegeLevel sharedTypes.PrivilegeLevel) error
	GetAccessTokens(ctx context.Context, projectId, userId sharedTypes.UUID, tokens *Tokens) error
	PopulateTokens(ctx context.Context, projectId, userId sharedTypes.UUID) (*Tokens, error)
	GetProjectNames(ctx context.Context, userId sharedTypes.UUID) (Names, error)
	SetCompiler(ctx context.Context, projectId, userId sharedTypes.UUID, compiler sharedTypes.Compiler) error
	SetImageName(ctx context.Context, projectId, userId sharedTypes.UUID, imageName sharedTypes.ImageName) error
	SetSpellCheckLanguage(ctx context.Context, projectId, userId sharedTypes.UUID, spellCheckLanguage spellingTypes.SpellCheckLanguage) error
	SetRootDoc(ctx context.Context, projectId, userId, rooDocId sharedTypes.UUID) error
	SetPublicAccessLevel(ctx context.Context, projectId, userId sharedTypes.UUID, level PublicAccessLevel) error
	ArchiveForUser(ctx context.Context, projectId, userId sharedTypes.UUID) error
	UnArchiveForUser(ctx context.Context, projectId, userId sharedTypes.UUID) error
	TrashForUser(ctx context.Context, projectId, userId sharedTypes.UUID) error
	UnTrashForUser(ctx context.Context, projectId, userId sharedTypes.UUID) error
	Rename(ctx context.Context, projectId, userId sharedTypes.UUID, name Name) error
	RemoveMember(ctx context.Context, projectId sharedTypes.UUID, actor, userId sharedTypes.UUID) error
	TransferOwnership(ctx context.Context, projectId, previousOwnerId, newOwnerId sharedTypes.UUID) (*user.WithPublicInfo, *user.WithPublicInfo, Name, error)
	CreateDoc(ctx context.Context, projectId, userId, folderId sharedTypes.UUID, d *Doc) (sharedTypes.Version, error)
	EnsureIsDoc(ctx context.Context, projectId, userId, folderId sharedTypes.UUID, d *Doc) (sharedTypes.UUID, bool, sharedTypes.Version, error)
	PrepareFileCreation(ctx context.Context, projectId, userId, folderId sharedTypes.UUID, f *FileRef) error
	FinalizeFileCreation(ctx context.Context, projectId, userId sharedTypes.UUID, f *FileRef) (sharedTypes.UUID, bool, sharedTypes.Version, error)
	ProcessStaleFileUploads(ctx context.Context, cutOff time.Time, fn func(projectId, fileId sharedTypes.UUID) bool) error
	PurgeStaleFileUpload(ctx context.Context, projectId, fileId sharedTypes.UUID) error
	ListProjectsWithName(ctx context.Context, userId sharedTypes.UUID) ([]WithIdAndName, error)
	GetOwnedProjects(ctx context.Context, userId sharedTypes.UUID) ([]sharedTypes.UUID, error)
	GetProjectListDetails(ctx context.Context, userId sharedTypes.UUID, r *ForProjectList) error
	SetContentLockedAt(ctx context.Context, projectId, userId sharedTypes.UUID, contentLocked *time.Time) (bool, error)
}

type Member struct {
	AccessSource   AccessSource
	PrivilegeLevel sharedTypes.PrivilegeLevel
	Archived       bool
	Trashed        bool
}

type Name string

type NameField struct {
	Name Name `json:"name"`
}

type Names []Name

type OwnerFeaturesField struct {
	OwnerFeatures user.Features `json:"features"`
}

type OwnerField struct {
	Owner user.WithPublicInfo `json:"owner"`
}

type OwnerIdField struct {
	OwnerId sharedTypes.UUID `json:"owner_ref"`
}

type PublicAccessLevel string

type PublicAccessLevelField struct {
	PublicAccessLevel PublicAccessLevel `json:"publicAccessLevel"`
}

type RootDoc struct {
	Doc
}

type RootDocField struct {
	RootDoc RootDoc `json:"root_doc"`
}

type RootDocIdField struct {
	RootDocId sharedTypes.UUID `json:"rootDoc_id"`
}

type RootFolderField struct {
	RootFolder Folder
}

type SpellCheckLanguageField struct {
	SpellCheckLanguage spellingTypes.SpellCheckLanguage `json:"spellCheckLanguage"`
}

type TokenAccessDetails struct {
	ProjectId sharedTypes.UUID
	Fresh     *AuthorizationDetails
	Existing  *AuthorizationDetails
}

type Tokens struct {
	ReadOnly           AccessToken `json:"readOnly"`
	ReadAndWrite       AccessToken `json:"readAndWrite"`
	ReadAndWritePrefix string      `json:"-"`
}

type TokensField struct {
	Tokens Tokens `json:"tokens"`
}

type TreeElement interface {
	GetId() sharedTypes.UUID
}

type TreeEntity struct {
	Path string `json:"path"`
	Type string `json:"type"`
}

type TreeNodeKind string

type VersionField struct {
	Version sharedTypes.Version `json:"version"`
}

type WithIdAndName struct {
	IdField
	NameField
}