@overmap-ai/core 1.0.74-model-indexes.3 → 1.0.74-more-clean-ups.0

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

@@ -1,21 +1,37 @@
 import { BaseSerializedObject, ISerializedField } from '@overmap-ai/forms';
 import { IssuePriority, IssueStatus, IssueUpdateChange } from '../../enums';
+import { COMMON_AUTO_FIELDS } from '../../utils';
 import { CSSColor } from '../colors';
-import { CreatedByModel, IndexedModel, Offline, OfflineModel, SubmittedAtModel, TimestampedModel } from './base';
+import { CreatedByModel, IndexedModel, OfflineModel, SubmittedAtModel, TimestampedModel } from './base';
 import { FieldsAttachmentModel, FieldsModel, FieldValuesModel } from './fields';
 import { CanvasMarkableModel, MarkableModel } from './geo';
 import { User } from './users';
+type FilteredKeys<T> = {
+    [P in keyof T]: T[P] extends never ? never : P;
+}[keyof T];
+type ExcludeNeverFields<O> = {
+    [K in FilteredKeys<O>]: O[K];
+};
+type PropertyUndefined<T> = {
+    [P in keyof T]?: T[P];
+};
+export type CommonAutoFields = (typeof COMMON_AUTO_FIELDS)[number];
 /**
  * Represents a model instance that has been submitted to the backend. Some properties (depending on which model, but in
  * all cases, the `offline_id`) are guaranteed to be set.
  */
-export type Submitted<TModel> = Offline<TModel> & (TModel extends Issue ? SubmittedIssue : Omit<TModel, "created_at" | "id">);
+export type Submitted<TModel> = Omit<TModel, CommonAutoFields> & PropertyUndefined<ExcludeNeverFields<{
+    created_at: "created_at" extends keyof TModel ? undefined : never;
+    updated_at: "updated_at" extends keyof TModel ? undefined : never;
+    index: "index" extends keyof TModel ? undefined : never;
+    revision: "revision" extends keyof TModel ? undefined : never;
+}>>;
 /**
  * Represents a model instance that has been submitted to the backend, accepted, then downloaded. Created models
  * typically have additional properties that are only known once it has been processed and accepted by the API, such as
  * the `created_at` timestamp, which is the time at which the data was written to the database.
  */
-export type Created<TModel> = Submitted<TModel> & (TModel extends Issue ? CreatedIssue : TModel extends IssueComment ? CreatedIssueComment : TModel);
+export type Created<TModel> = TModel;
 /**
  * Model instances that are stored in the Redux store can be already-created (and will likely be gotten with the initial
  * data load), or to-be-created. In the former case, you will get a `Created<TModel>`. In the latter case, you will get
@@ -37,40 +53,11 @@ export interface Issue extends OfflineModel, SubmittedAtModel, CreatedByModel, M
     issue_type: string;
     project: number;
 }
-/**
- * These details need to be provided by the frontend code before submitting to the backend.
- */
-export interface SubmittedIssue extends OfflineModel, CreatedByModel {
-    submitted_at: string;
-    status: Exclude<Issue["status"], undefined>;
-    priority: Exclude<Issue["priority"], undefined>;
-}
-/**
- * These details exist on issues that have been successfully submitted, accepted, created, and serialized by the
- * backend, then downloaded by the frontend.
- */
-export interface CreatedIssue extends Issue {
-    title: Exclude<Issue["title"], undefined>;
-    description: Exclude<Issue["description"], undefined>;
-    assigned_to: Exclude<Issue["assigned_to"], undefined>;
-    due_date: Exclude<Issue["due_date"], undefined>;
-    category: Exclude<Issue["category"], undefined>;
-    geo_marker: Exclude<Issue["geo_marker"], undefined>;
-    created_at: string;
-}
 export interface IssueComment extends OfflineModel, SubmittedAtModel, TimestampedModel {
     issue: string;
     content: string;
     author?: number;
 }
-export interface SubmittedIssueComment {
-    created_at: Exclude<IssueComment["created_at"], undefined>;
-}
-export interface CreatedIssueComment {
-    author: Exclude<IssueComment["author"], undefined>;
-    created_at: Exclude<IssueComment["created_at"], undefined>;
-}
-export type IssueCommentPayload = Omit<IssueComment, "author" | "created_at" | "offline_id">;
 export interface IssueUpdateChangeTypes {
     status: IssueStatus;
     priority: IssuePriority;
@@ -110,3 +97,4 @@ export interface IssueTypeFieldValues extends OfflineModel, SubmittedAtModel, Ti
 export interface IssueTypeFieldValuesAttachment extends OfflineModel, SubmittedAtModel, TimestampedModel, CreatedByModel, FieldsAttachmentModel {
     field_values: string;
 }
+export {};

package/dist/utils/offline.d.ts

@@ -1,4 +1,5 @@
 import { Offline, OfflineModel } from '../typings';
+export declare const COMMON_AUTO_FIELDS: readonly ["created_at", "updated_at", "index", "revision"];
 /**
  * Adds a generated UUID to the "offline_id" key of the object.
  * @param draft The model data to add the offline_id to

package/dist/utils/utils.d.ts

@@ -4,4 +4,5 @@ export declare const restructureCreateSelectorWithArgs: <TArgs, TRet>(selector:
 export declare function onlyUniqueOfflineIds(value: OfflineModel, index: number, self: OfflineModel[]): boolean;
 export declare function onlyUniqueHashes(value: IssueAttachment, index: number, self: IssueAttachment[]): boolean;
 export declare const emailRegex: RegExp;
+export declare function createPayload<TPayload extends object>(payload: TPayload): TPayload;
 export {};

package/package.json

@@ -3,7 +3,7 @@
 	"description": "Core functionality for Overmap",
 	"author": "Wôrdn Inc.",
 	"license": "UNLICENSED",
-	"version": "1.0.74-model-indexes.3",
+	"version": "1.0.74-more-clean-ups.0",
 	"type": "module",
 	"main": "dist/overmap-core.umd.cjs",
 	"module": "dist/overmap-core.js",