@overmap-ai/core 1.0.45-batch-bug-fixes.0 → 1.0.46-project-attachments.0

package/dist/sdk/sdk.d.ts

@@ -1,4 +1,4 @@
-import { AttachmentService, AuthService, CategoryService, ComponentService, ComponentStageCompletionService, ComponentStageService, ComponentTypeService, EmailVerificationService, FileService, IssueCommentService, IssueService, MainService, OrganizationAccessService, ProjectAccessService, ProjectFileService, ProjectService, UserFormService, UserFormSubmissionService, WorkspaceService, OrganizationService, EmailDomainsService, LicenseService } from "./services";
+import { AttachmentService, AuthService, CategoryService, ComponentService, ComponentStageCompletionService, ComponentStageService, ComponentTypeService, EmailVerificationService, FileService, IssueCommentService, IssueService, MainService, OrganizationAccessService, ProjectAccessService, ProjectFileService, ProjectService, UserFormService, UserFormSubmissionService, WorkspaceService, OrganizationService, EmailDomainsService, LicenseService, DocumentService } from "./services";
 import { ToolkitStore } from "@reduxjs/toolkit/dist/configureStore.js";
 import { RootState } from "../typings";
 export declare class OvermapSDK {
@@ -27,5 +27,6 @@ export declare class OvermapSDK {
     emailVerification: EmailVerificationService;
     emailDomains: EmailDomainsService;
     licenses: LicenseService;
+    documents: DocumentService;
 }
 export declare const makeClient: (apiUrl: string, store: ToolkitStore<RootState>) => OvermapSDK;

package/dist/sdk/services/AttachmentService.d.ts

@@ -1,6 +1,6 @@
 import { BaseApiService } from "./BaseApiService";
 import type { OptimisticModelResult } from "../typings";
-import { ComponentAttachment, ComponentTypeAttachment, Created, IssueAttachment, MaybeObjectURL, AttachmentPayload, Stored } from "../../typings";
+import { ComponentAttachment, ComponentTypeAttachment, Created, IssueAttachment, MaybeObjectURL, AttachmentPayload, Stored, ProjectAttachment, Project } from "../../typings";
 /**
  * Handles creation and caching of attachments
  */
@@ -8,23 +8,27 @@ interface StoredAttachments {
     issue_attachments: Stored<IssueAttachment>[];
     component_attachments: Stored<ComponentAttachment>[];
     component_type_attachments: Stored<ComponentTypeAttachment>[];
+    project_attachments: Stored<ProjectAttachment>[];
 }
 interface CreatedAttachments {
     issue_attachments: Created<IssueAttachment>[];
     component_attachments: Created<ComponentAttachment>[];
     component_type_attachments: Created<ComponentTypeAttachment>[];
+    project_attachments: Created<ProjectAttachment>[];
 }
 export declare class AttachmentService extends BaseApiService {
     fetchAll(projectId: number): [StoredAttachments, Promise<CreatedAttachments>];
     addIssueAttachment(attachmentPayload: AttachmentPayload<IssueAttachment>): Promise<OptimisticModelResult<IssueAttachment>>;
     addComponentAttachment(attachmentPayload: AttachmentPayload<ComponentAttachment>): Promise<OptimisticModelResult<ComponentAttachment>>;
     addComponentTypeAttachment(attachmentPayload: AttachmentPayload<ComponentTypeAttachment>): Promise<OptimisticModelResult<ComponentTypeAttachment>>;
+    addProjectAttachment(attachmentPayload: AttachmentPayload<ProjectAttachment>): Promise<OptimisticModelResult<ProjectAttachment>>;
     /** the outer Promise is needed to await the hashing of each file, which is required before offline use. If wanting to
      * attach promise handlers to the request to add the attachment in the backend, apply it on the promise returned from the
      * OptimisticModelResult. */
     attachFilesToIssue(filesToSubmit: File[], issueId: string): Promise<OptimisticModelResult<IssueAttachment>>[];
     attachFilesToComponent(filesToSubmit: File[], componentId: string): Promise<OptimisticModelResult<ComponentAttachment>>[];
     attachFilesToComponentType(filesToSubmit: File[], componentTypeId: string): Promise<OptimisticModelResult<ComponentTypeAttachment>>[];
+    attachFilesToProjectType(filesToSubmit: File[], projectId: Project["id"]): Promise<OptimisticModelResult<ProjectAttachment>>[];
     replaceIssueAttachmentFile(attachmentId: string, newFile: MaybeObjectURL<File>): Promise<OptimisticModelResult<IssueAttachment>>;
     replaceComponentAttachmentFile(attachmentId: string, newFile: MaybeObjectURL<File>): Promise<OptimisticModelResult<ComponentAttachment>>;
     replaceComponentTypeAttachmentFile(attachmentId: string, newFile: MaybeObjectURL<File>): Promise<OptimisticModelResult<ComponentTypeAttachment>>;
@@ -35,5 +39,6 @@ export declare class AttachmentService extends BaseApiService {
     deleteIssueAttachment(issueAttachmentId: string): Promise<undefined>;
     deleteComponentAttachment(componentAttachmentId: string): Promise<undefined>;
     deleteComponentTypeAttachment(componentTypeAttachmentId: string): Promise<undefined>;
+    deleteProjectAttachment(projectAttachmentId: string): Promise<undefined>;
 }
 export {};

package/dist/sdk/services/DocumentService.d.ts

@@ -0,0 +1,10 @@
+import { BaseApiService } from "./BaseApiService";
+import { MovePosition, Payload, ProjectDocument, Submitted } from "../../typings";
+import { OptimisticModelResult } from "../typings";
+export declare class DocumentService extends BaseApiService {
+    add(document: Payload<ProjectDocument>): OptimisticModelResult<ProjectDocument>;
+    update(document: Submitted<Partial<ProjectDocument>>): OptimisticModelResult<ProjectDocument>;
+    move(documentId: string, targetDocumentId: string | null, position: MovePosition): Promise<ProjectDocument[]>;
+    delete(documentId: string): Promise<ProjectDocument[]>;
+    refreshStore(): Promise<void>;
+}

package/dist/sdk/services/index.d.ts

@@ -20,4 +20,5 @@ export * from "./FileService";
 export * from "./EmailVerificationService";
 export * from "./EmailDomainsService";
 export * from "./OrganizationService";
-export * from "./LicenseService.ts";
+export * from "./LicenseService";
+export * from "./DocumentService";

package/dist/sdk/typings.d.ts

@@ -23,7 +23,7 @@ export interface RequestDetails {
     immediate?: boolean;
     isExternalUrl?: boolean;
     isResponseBlob?: boolean;
-    queryParams?: Record<string, string>;
+    queryParams?: Record<string, string | undefined>;
     isAuthNeeded?: boolean;
     /** The hash of any included attachments being uploaded to S3, retrieved from cache before the request is fired */
     attachmentHash?: string;

package/dist/store/slices/categorySlice.d.ts

@@ -65,6 +65,7 @@ export declare const selectCategories: ((state: import("redux").EmptyObject & {
     workspaceReducer: import('..').WorkspaceState;
     emailDomainsReducer: import('..').EmailDomainState;
     licenseReducer: import('..').LicenseState;
+    documentsReducer: import('..').DocumentState;
 } & {
     offline: import("@redux-offline/redux-offline/lib/types").OfflineState;
 }) => Category[]) & import("reselect").OutputSelectorFields<(args_0: Record<string, Category>, args_1: string | null) => Category[], {

package/dist/store/slices/documentSlice.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="@redux-offline/redux-offline" />
+import { Reducer } from "@reduxjs/toolkit";
+import { MovePosition, ProjectDocument, RootState, Stored, Submitted } from "../../typings";
+import { AppSelector } from "./componentTypeSlice";
+export interface DocumentState {
+    documents: Record<string, Stored<ProjectDocument>>;
+}
+export interface MoveDocumentPayload {
+    documentId: ProjectDocument["offline_id"];
+    targetDocumentId: ProjectDocument["offline_id"] | null;
+    position: MovePosition;
+}
+export declare const documentSlice: import("@reduxjs/toolkit").Slice<DocumentState, {
+    setDocuments: (state: import("immer/dist/internal.js").WritableDraft<DocumentState>, action: {
+        payload: ProjectDocument[];
+    }) => void;
+    addDocuments: (state: import("immer/dist/internal.js").WritableDraft<DocumentState>, action: {
+        payload: ProjectDocument[];
+    }) => void;
+    updateDocuments: (state: import("immer/dist/internal.js").WritableDraft<DocumentState>, action: {
+        payload: Submitted<Partial<ProjectDocument>>[];
+    }) => void;
+    moveDocument: (state: import("immer/dist/internal.js").WritableDraft<DocumentState>, action: {
+        payload: MoveDocumentPayload;
+    }) => void;
+    removeDocuments: (state: import("immer/dist/internal.js").WritableDraft<DocumentState>, action: {
+        payload: string[];
+    }) => void;
+}, "documents">;
+export declare const setDocuments: import("@reduxjs/toolkit").ActionCreatorWithPayload<ProjectDocument[], "documents/setDocuments">, addDocuments: import("@reduxjs/toolkit").ActionCreatorWithPayload<ProjectDocument[], "documents/addDocuments">, updateDocuments: import("@reduxjs/toolkit").ActionCreatorWithPayload<Submitted<Partial<ProjectDocument>>[], "documents/updateDocuments">, moveDocument: import("@reduxjs/toolkit").ActionCreatorWithPayload<MoveDocumentPayload, "documents/moveDocument">, removeDocuments: import("@reduxjs/toolkit").ActionCreatorWithPayload<string[], "documents/removeDocuments">;
+export declare const selectDocumentsMapping: AppSelector<Record<string, Stored<ProjectDocument>>>;
+export declare const selectDocuments: AppSelector<Stored<ProjectDocument>[]>;
+export declare const selectDocument: (args: string) => (state: RootState) => Stored<ProjectDocument> | undefined;
+export declare const selectRootDocuments: ((state: import("redux").EmptyObject & {
+    versioning: import('../slices/versioningSlice').VersioningState;
+    fileReducer: import('..').FileState;
+    authReducer: import('..').AuthState;
+    categoryReducer: import('..').CategoryState;
+    componentReducer: import('..').ComponentState;
+    componentStageCompletionReducer: import('..').ComponentStageCompletionState;
+    componentStageReducer: import('..').ComponentStageState;
+    componentTypeReducer: import("./componentTypeSlice").ComponentTypeState;
+    issueReducer: import('..').IssueState;
+    mapReducer: import('..').MapState;
+    organizationReducer: import('..').OrganizationState;
+    outboxReducer: import('..').OutboxState;
+    projectReducer: import('..').ProjectState;
+    projectAccessReducer: import('..').ProjectAccessState;
+    organizationAccessReducer: import('..').OrganizationAccessState;
+    projectFileReducer: import('..').ProjectFileState;
+    rehydratedReducer: import('..').RehydratedState;
+    settingReducer: import('..').SettingState;
+    userFormReducer: import('..').UserFormState;
+    userReducer: import('..').UserState;
+    workspaceReducer: import('..').WorkspaceState;
+    emailDomainsReducer: import('..').EmailDomainState;
+    licenseReducer: import('..').LicenseState;
+    documentsReducer: DocumentState;
+} & {
+    offline: import("@redux-offline/redux-offline/lib/types").OfflineState;
+}) => Stored<ProjectDocument>[]) & import("reselect").OutputSelectorFields<(args_0: Stored<ProjectDocument>[]) => Stored<ProjectDocument>[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const documentsReducer: Reducer<DocumentState>;

package/dist/store/slices/index.d.ts

@@ -20,3 +20,4 @@ export * from "./workspaceSlice";
 export * from "./organizationAccessSlice";
 export * from "./emailDomainsSlice";
 export * from "./licenseSlice";
+export * from "./documentSlice";

package/dist/store/slices/issueSlice.d.ts

@@ -118,6 +118,7 @@ export declare const selectAllAttachments: ((state: import("redux").EmptyObject
     workspaceReducer: import("./workspaceSlice").WorkspaceState;
     emailDomainsReducer: import('..').EmailDomainState;
     licenseReducer: import('..').LicenseState;
+    documentsReducer: import('..').DocumentState;
 } & {
     offline: import("@redux-offline/redux-offline/lib/types").OfflineState;
 }) => Stored<IssueAttachment>[]) & import("reselect").OutputSelectorFields<(args_0: Record<string, Stored<IssueAttachment>>) => Stored<IssueAttachment>[], {

package/dist/store/slices/projectFileSlice.d.ts

@@ -73,6 +73,7 @@ export declare const selectProjectFiles: ((state: import("redux").EmptyObject &
     workspaceReducer: import('..').WorkspaceState;
     emailDomainsReducer: import('..').EmailDomainState;
     licenseReducer: import('..').LicenseState;
+    documentsReducer: import('..').DocumentState;
 } & {
     offline: import("@redux-offline/redux-offline/lib/types").OfflineState;
 }) => ProjectFile[]) & import("reselect").OutputSelectorFields<(args_0: Record<string, ProjectFile>, args_1: number | null) => ProjectFile[], {

package/dist/store/slices/projectSlice.d.ts

@@ -1,11 +1,12 @@
 import { Reducer } from "@reduxjs/toolkit";
-import { Project, ProjectType, RootState, Selector, User } from "../../typings";
+import { Project, ProjectAttachment, ProjectType, RootState, Selector, Stored, User } from "../../typings";
 export interface ProjectState {
     projects: Record<number, Project>;
     activeProjectId: number | null;
     recentProjectIds: number[];
     recentSearchableQueries: string[];
     createProjectType: ProjectType;
+    attachments: Record<string, Stored<ProjectAttachment>>;
 }
 export declare const projectSlice: import("@reduxjs/toolkit").Slice<ProjectState, {
     setProjects: (state: import("immer/dist/internal.js").WritableDraft<ProjectState>, action: {
@@ -35,8 +36,32 @@ export declare const projectSlice: import("@reduxjs/toolkit").Slice<ProjectState
     addActiveProjectFormSubmissionsCount: (state: import("immer/dist/internal.js").WritableDraft<ProjectState>, action: {
         payload: number;
     }) => void;
+    setProjectAttachments: (state: ProjectState, action: {
+        payload: import('../../typings/models/issues').Created<ProjectAttachment>[];
+        type: string;
+    }) => void;
+    addProjectAttachment: (state: ProjectState, action: {
+        payload: import('../../typings/models/issues').Submitted<ProjectAttachment>;
+        type: string;
+    }) => void;
+    addProjectAttachments: (state: ProjectState, action: {
+        payload: import('../../typings/models/issues').Submitted<ProjectAttachment>[];
+        type: string;
+    }) => void;
+    updateProjectAttachment: (state: ProjectState, action: {
+        payload: import('../../typings/models/issues').Submitted<ProjectAttachment>;
+        type: string;
+    }) => void;
+    removeProjectAttachment: (state: ProjectState, action: {
+        payload: string;
+        type: string;
+    }) => void;
+    removeProjectAttachments: (state: ProjectState, action: {
+        payload: string[];
+        type: string;
+    }) => void;
 }, "projects">;
-export declare const setProjects: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project[], "projects/setProjects">, updateOrCreateProject: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project, "projects/updateOrCreateProject">, addOrReplaceProjects: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project[], "projects/updateOrCreateProjects">, setActiveProjectId: import("@reduxjs/toolkit").ActionCreatorWithPayload<number | null, "projects/setActiveProjectId">, setCreateProjectType: import("@reduxjs/toolkit").ActionCreatorWithPayload<ProjectType, "projects/setCreateProjectType">, deleteProject: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project, "projects/deleteProject">, acceptProjectInvite: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/acceptProjectInvite">, addActiveProjectIssuesCount: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/addActiveProjectIssuesCount">, addActiveProjectFormSubmissionsCount: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/addActiveProjectFormSubmissionsCount">;
+export declare const setProjects: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project[], "projects/setProjects">, updateOrCreateProject: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project, "projects/updateOrCreateProject">, addOrReplaceProjects: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project[], "projects/updateOrCreateProjects">, setActiveProjectId: import("@reduxjs/toolkit").ActionCreatorWithPayload<number | null, "projects/setActiveProjectId">, setCreateProjectType: import("@reduxjs/toolkit").ActionCreatorWithPayload<ProjectType, "projects/setCreateProjectType">, deleteProject: import("@reduxjs/toolkit").ActionCreatorWithPayload<Project, "projects/deleteProject">, acceptProjectInvite: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/acceptProjectInvite">, addActiveProjectIssuesCount: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/addActiveProjectIssuesCount">, addActiveProjectFormSubmissionsCount: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "projects/addActiveProjectFormSubmissionsCount">, setProjectAttachments: import("@reduxjs/toolkit").ActionCreatorWithPayload<import('../../typings/models/issues').Created<ProjectAttachment>[], "projects/setProjectAttachments">, addProjectAttachment: import("@reduxjs/toolkit").ActionCreatorWithPayload<import('../../typings/models/issues').Submitted<ProjectAttachment>, "projects/addProjectAttachment">, addProjectAttachments: import("@reduxjs/toolkit").ActionCreatorWithPayload<import('../../typings/models/issues').Submitted<ProjectAttachment>[], "projects/addProjectAttachments">, updateProjectAttachment: import("@reduxjs/toolkit").ActionCreatorWithPayload<import('../../typings/models/issues').Submitted<ProjectAttachment>, "projects/updateProjectAttachment">, removeProjectAttachment: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "projects/removeProjectAttachment">, removeProjectAttachments: import("@reduxjs/toolkit").ActionCreatorWithPayload<string[], "projects/removeProjectAttachments">;
 export declare const selectProjects: Selector<Record<number, Project>>;
 export declare const selectActiveProjectId: (state: RootState) => number | null;
 export declare const selectActiveProject: (state: RootState) => Project | null;
@@ -48,3 +73,10 @@ export declare const selectProjectUsersIds: Selector<number[]>;
 export declare const selectProjectUsersAsMapping: Selector<Record<number, User>>;
 export declare const selectProjectsWithAccess: Selector<Project[]>;
 export declare const selectSortedProjectUsers: Selector<User[]>;
+export declare const selectProjectAttachmentMapping: (state: RootState) => Record<string, Stored<ProjectAttachment>>;
+export declare const selectAllProjectAttachments: Selector<Stored<ProjectAttachment>[]>;
+export declare const selectAttachmentsOfProject: (args: number) => (state: RootState) => Stored<ProjectAttachment>[];
+export declare const selectAttachmentsOfProjectByType: (args: number) => (state: RootState) => {
+    fileAttachments: Stored<ProjectAttachment>[];
+    imageAttachments: Stored<ProjectAttachment>[];
+};

package/dist/store/slices/workspaceSlice.d.ts

@@ -51,6 +51,7 @@ export declare const selectWorkspaces: ((state: import("redux").EmptyObject & {
     workspaceReducer: WorkspaceState;
     emailDomainsReducer: import('..').EmailDomainState;
     licenseReducer: import('..').LicenseState;
+    documentsReducer: import('..').DocumentState;
 } & {
     offline: import("@redux-offline/redux-offline/lib/types").OfflineState;
 }) => Workspace[]) & import("reselect").OutputSelectorFields<(args_0: Record<string, Workspace>) => Workspace[], {

package/dist/store/store.d.ts

@@ -3,7 +3,7 @@ import { AnyAction, Reducer } from "redux";
 import { Config, OfflineAction, OfflineMetadata, OfflineState } from "@redux-offline/redux-offline/lib/types";
 import request from "superagent";
 import { type OfflineMetaEffect, type OvermapSDK, RequestDetails } from "../sdk";
-import { AuthState, CategoryState, ComponentStageCompletionState, ComponentStageState, ComponentState, ComponentTypeState, EmailDomainState, FileState, IssueState, LicenseState, MapState, OrganizationAccessState, OrganizationState, OutboxState, ProjectAccessState, ProjectFileState, ProjectState, RehydratedState, SettingState, UserFormState, UserState, WorkspaceState } from "./slices";
+import { AuthState, CategoryState, ComponentStageCompletionState, ComponentStageState, ComponentState, ComponentTypeState, EmailDomainState, FileState, IssueState, LicenseState, MapState, OrganizationAccessState, OrganizationState, OutboxState, ProjectAccessState, ProjectFileState, ProjectState, RehydratedState, SettingState, UserFormState, UserState, WorkspaceState, DocumentState } from "./slices";
 import { VersioningState } from "./slices/versioningSlice";
 import { RootState } from "../typings";
 export declare const overmapReducers: {
@@ -30,6 +30,7 @@ export declare const overmapReducers: {
     workspaceReducer: Reducer<WorkspaceState>;
     emailDomainsReducer: Reducer<EmailDomainState>;
     licenseReducer: Reducer<LicenseState>;
+    documentsReducer: Reducer<DocumentState>;
 };
 export declare const overmapReducer: Reducer<import("redux").CombinedState<{
     versioning: VersioningState;
@@ -55,6 +56,7 @@ export declare const overmapReducer: Reducer<import("redux").CombinedState<{
     workspaceReducer: WorkspaceState;
     emailDomainsReducer: EmailDomainState;
     licenseReducer: LicenseState;
+    documentsReducer: DocumentState;
 }>, AnyAction>;
 export declare const resetStore = "RESET";
 export declare const rootReducer: Reducer<RootState>;
@@ -98,6 +100,7 @@ export declare const defaultStore: import("@reduxjs/toolkit/dist/configureStore"
     workspaceReducer: WorkspaceState;
     emailDomainsReducer: EmailDomainState;
     licenseReducer: LicenseState;
+    documentsReducer: DocumentState;
 } & {
     offline: OfflineState;
 }, AnyAction, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<RootState, AnyAction>]>>;

package/dist/typings/models/attachments.d.ts

@@ -1,5 +1,6 @@
 import { OfflineModel } from "./base";
 import { MaybeObjectURL, UploadedFileModel } from "../files";
+import { Project } from "./projects";
 export interface Attachment extends OfflineModel, UploadedFileModel {
     description?: string;
     file_name: string;
@@ -14,6 +15,9 @@ export interface ComponentAttachment extends Attachment, UploadedFileModel {
 export interface ComponentTypeAttachment extends Attachment, UploadedFileModel {
     component_type: string;
 }
+export interface ProjectAttachment extends Attachment, UploadedFileModel {
+    project: Project["id"];
+}
 /** to get an AttachmentPayload for a specific type, pass in the given AttachmentType
  * ex. AttachmentPayload<IssueAttachment> */
 export type AttachmentPayload<TAttachment> = Omit<TAttachment, "file"> & {

package/dist/typings/models/documents.d.ts

@@ -0,0 +1,11 @@
+import { OfflineModel } from "./base";
+import { User } from "./users";
+export interface ProjectDocument extends OfflineModel {
+    title: string | null;
+    description: string | null;
+    content: string | null;
+    created_by: User["id"];
+    parent_document: ProjectDocument["offline_id"] | null;
+    children_documents: ProjectDocument["offline_id"][];
+}
+export type MovePosition = "left" | "right" | "left-child" | "right-child";

package/dist/typings/models/index.d.ts

@@ -14,3 +14,4 @@ export * from "./emailVerification";
 export * from "./store";
 export * from "./emailDomain";
 export * from "./license";
+export * from "./documents";

package/package.json

@@ -3,7 +3,7 @@
 	"description": "Core functionality for Overmap",
 	"author": "Wôrdn Inc.",
 	"license": "UNLICENSED",
-	"version": "1.0.45-batch-bug-fixes.0",
+	"version": "1.0.46-project-attachments.0",
 	"type": "module",
 	"main": "dist/overmap-core.umd.cjs",
 	"module": "dist/overmap-core.js",