@taylordb/shared 0.3.0 → 0.4.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TaylorDB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/column-types.d.ts

@@ -4,18 +4,159 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export type ColumnType<S, U, I, T> = {
+interface FileInformation {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    destination: string;
+    filename: string;
+    path: string;
+    size: number;
+    format: string;
+    width: number;
+    height: number;
+}
+interface UploadResponse {
+    collectionName: string;
+    fileInformation: FileInformation;
+    metadata: {
+        thumbnails: any[];
+        clips: any[];
+    };
+    baseId: string;
+    storageAdaptor: string;
+    _id: string;
+    __v: number;
+}
+export interface AttachmentColumnValue {
+    url: string;
+    fileType: string;
+    size: number;
+}
+export declare class Attachment {
+    readonly collectionName: string;
+    readonly fileInformation: FileInformation;
+    readonly metadata: {
+        thumbnails: any[];
+        clips: any[];
+    };
+    readonly baseId: string;
+    readonly storageAdaptor: string;
+    readonly _id: string;
+    constructor(data: UploadResponse);
+    toColumnValue(): AttachmentColumnValue;
+}
+type IsWithinOperatorValue = 'pastWeek' | 'pastMonth' | 'pastYear' | 'nextWeek' | 'nextMonth' | 'nextYear' | 'daysFromNow' | 'daysAgo' | 'currentWeek' | 'currentMonth' | 'currentYear';
+type DefaultDateFilterValue = ('today' | 'tomorrow' | 'yesterday' | 'oneWeekAgo' | 'oneWeekFromNow' | 'oneMonthAgo' | 'oneMonthFromNow') | ['exactDay' | 'exactTimestamp', string] | ['daysAgo' | 'daysFromNow', number];
+type DateFilters = {
+    '=': DefaultDateFilterValue;
+    '!=': DefaultDateFilterValue;
+    '<': DefaultDateFilterValue;
+    '>': DefaultDateFilterValue;
+    '<=': DefaultDateFilterValue;
+    '>=': DefaultDateFilterValue;
+    isWithIn: IsWithinOperatorValue | {
+        value: 'daysAgo' | 'daysFromNow';
+        date: number;
+    };
+    isEmpty: boolean;
+    isNotEmpty: boolean;
+};
+type DateAggregations = {
+    empty: number;
+    filled: number;
+    unique: number;
+    percentEmpty: number;
+    percentFilled: number;
+    percentUnique: number;
+    min: number | null;
+    max: number | null;
+    daysRange: number | null;
+    monthRange: number | null;
+};
+type TextFilters = {
+    '=': string;
+    '!=': string;
+    caseEqual: string;
+    hasAnyOf: string[];
+    contains: string;
+    startsWith: string;
+    endsWith: string;
+    doesNotContain: string;
+};
+type LinkFilters = {
+    hasAnyOf: number[];
+    hasAllOf: number[];
+    isExactly: number[];
+    '=': number;
+    hasNoneOf: number[];
+};
+type LinkAggregations = {
+    empty: number;
+    filled: number;
+    percentEmpty: number;
+    percentFilled: number;
+};
+type NumberFilters = {
+    '>': number;
+    '>=': number;
+    '<': number;
+    '<=': number;
+    hasAnyOf: number[];
+    hasNoneOf: number[];
+};
+type NumberAggregations = {
+    sum: number;
+    average: number;
+    median: number;
+    min: number | null;
+    max: number | null;
+    range: number;
+    standardDeviation: number;
+    histogram: Record<string, number>;
+    empty: number;
+    filled: number;
+    unique: number;
+    percentEmpty: number;
+    percentFilled: number;
+    percentUnique: number;
+};
+type CheckboxFilters = {
+    '=': number;
+};
+/**
+ *
+ * Column types
+ *
+ */
+export type ColumnType<S, U, I, R extends boolean, F extends {
+    [key: string]: any;
+} = object, A extends {
+    [key: string]: any;
+} = object> = {
     raw: S;
     insert: I;
     update: U;
-    type: T;
+    filters: F;
+    aggregations: A;
+    isRequired: R;
 };
-export type TextColumnType = ColumnType<string | undefined, string | undefined, string | null, 'text'>;
-export type LinkColumnType<T extends string> = ColumnType<object, number[] | {
-    newIds: number[];
-    deletedIds: number[];
-} | undefined, number[] | undefined, 'link'> & {
+export type DateColumnType<R extends boolean> = ColumnType<string, string, string, R, DateFilters, DateAggregations>;
+export type TextColumnType<R extends boolean> = ColumnType<string, string, string, R, TextFilters>;
+export type ALinkColumnType<T extends string, S, U, I, R extends boolean> = ColumnType<S, U, I, R, LinkFilters, LinkAggregations> & {
     linkedTo: T;
 };
-export type NumberColumnType = ColumnType<number | undefined, number | undefined, number | undefined, 'number'>;
-export type CheckboxColumnType = ColumnType<boolean | undefined, boolean | undefined, boolean | undefined, 'checkbox'>;
+export type LinkColumnType<T extends string, R extends boolean> = ALinkColumnType<T, object, number | number[] | {
+    newIds: number[];
+    deletedIds: number[];
+}, number | number[], R>;
+export type AttachmentColumnType<R extends boolean> = ALinkColumnType<'attachmentTable', Attachment[], Attachment[] | {
+    newIds: number[];
+    deletedIds: number[];
+} | number[], Attachment[] | number[], R>;
+export type NumberColumnType<R extends boolean> = ColumnType<number, number, number, R, NumberFilters, NumberAggregations>;
+export type CheckboxColumnType<R extends boolean> = ColumnType<boolean, boolean, boolean, R, CheckboxFilters>;
+export type AutoGeneratedNumberColumnType = ColumnType<number, never, never, false, NumberFilters, NumberAggregations>;
+export type AutoGeneratedDateColumnType = ColumnType<string, never, never, false, DateFilters, DateAggregations>;
+export {};

package/dist/cjs/column-types.js

@@ -6,4 +6,29 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Attachment = void 0;
+class Attachment {
+    collectionName;
+    fileInformation;
+    metadata;
+    baseId;
+    storageAdaptor;
+    _id;
+    constructor(data) {
+        this.collectionName = data.collectionName;
+        this.fileInformation = data.fileInformation;
+        this.metadata = data.metadata;
+        this.baseId = data.baseId;
+        this.storageAdaptor = data.storageAdaptor;
+        this._id = data._id;
+    }
+    toColumnValue() {
+        return {
+            url: this.fileInformation.path,
+            fileType: this.fileInformation.mimetype,
+            size: this.fileInformation.size,
+        };
+    }
+}
+exports.Attachment = Attachment;
 //# sourceMappingURL=column-types.js.map

package/dist/cjs/column-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"column-types.js","sourceRoot":"","sources":["../../src/column-types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
+{"version":3,"file":"column-types.js","sourceRoot":"","sources":["../../src/column-types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAmCH,MAAa,UAAU;IACL,cAAc,CAAS;IACvB,eAAe,CAAkB;IACjC,QAAQ,CAAsC;IAC9C,MAAM,CAAS;IACf,cAAc,CAAS;IACvB,GAAG,CAAS;IAE5B,YAAY,IAAoB;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;IACtB,CAAC;IAED,aAAa;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;YAC9B,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ;YACvC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;SAChC,CAAC;IACJ,CAAC;CACF;AAxBD,gCAwBC"}

package/dist/cjs/index.d.ts

@@ -1,5 +1,4 @@
 export * from './@types/index.js';
 export * from './column-types.js';
 export * from './constants/index.js';
-export * from './table-types.js';
 export * from './utilities/index.js';

package/dist/cjs/index.js

@@ -17,6 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./@types/index.js"), exports);
 __exportStar(require("./column-types.js"), exports);
 __exportStar(require("./constants/index.js"), exports);
-__exportStar(require("./table-types.js"), exports);
 __exportStar(require("./utilities/index.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,oDAAkC;AAClC,uDAAqC;AACrC,mDAAiC;AACjC,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,oDAAkC;AAClC,uDAAqC;AACrC,uDAAqC"}

package/dist/esm/column-types.d.ts

@@ -4,18 +4,159 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export type ColumnType<S, U, I, T> = {
+interface FileInformation {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    destination: string;
+    filename: string;
+    path: string;
+    size: number;
+    format: string;
+    width: number;
+    height: number;
+}
+interface UploadResponse {
+    collectionName: string;
+    fileInformation: FileInformation;
+    metadata: {
+        thumbnails: any[];
+        clips: any[];
+    };
+    baseId: string;
+    storageAdaptor: string;
+    _id: string;
+    __v: number;
+}
+export interface AttachmentColumnValue {
+    url: string;
+    fileType: string;
+    size: number;
+}
+export declare class Attachment {
+    readonly collectionName: string;
+    readonly fileInformation: FileInformation;
+    readonly metadata: {
+        thumbnails: any[];
+        clips: any[];
+    };
+    readonly baseId: string;
+    readonly storageAdaptor: string;
+    readonly _id: string;
+    constructor(data: UploadResponse);
+    toColumnValue(): AttachmentColumnValue;
+}
+type IsWithinOperatorValue = 'pastWeek' | 'pastMonth' | 'pastYear' | 'nextWeek' | 'nextMonth' | 'nextYear' | 'daysFromNow' | 'daysAgo' | 'currentWeek' | 'currentMonth' | 'currentYear';
+type DefaultDateFilterValue = ('today' | 'tomorrow' | 'yesterday' | 'oneWeekAgo' | 'oneWeekFromNow' | 'oneMonthAgo' | 'oneMonthFromNow') | ['exactDay' | 'exactTimestamp', string] | ['daysAgo' | 'daysFromNow', number];
+type DateFilters = {
+    '=': DefaultDateFilterValue;
+    '!=': DefaultDateFilterValue;
+    '<': DefaultDateFilterValue;
+    '>': DefaultDateFilterValue;
+    '<=': DefaultDateFilterValue;
+    '>=': DefaultDateFilterValue;
+    isWithIn: IsWithinOperatorValue | {
+        value: 'daysAgo' | 'daysFromNow';
+        date: number;
+    };
+    isEmpty: boolean;
+    isNotEmpty: boolean;
+};
+type DateAggregations = {
+    empty: number;
+    filled: number;
+    unique: number;
+    percentEmpty: number;
+    percentFilled: number;
+    percentUnique: number;
+    min: number | null;
+    max: number | null;
+    daysRange: number | null;
+    monthRange: number | null;
+};
+type TextFilters = {
+    '=': string;
+    '!=': string;
+    caseEqual: string;
+    hasAnyOf: string[];
+    contains: string;
+    startsWith: string;
+    endsWith: string;
+    doesNotContain: string;
+};
+type LinkFilters = {
+    hasAnyOf: number[];
+    hasAllOf: number[];
+    isExactly: number[];
+    '=': number;
+    hasNoneOf: number[];
+};
+type LinkAggregations = {
+    empty: number;
+    filled: number;
+    percentEmpty: number;
+    percentFilled: number;
+};
+type NumberFilters = {
+    '>': number;
+    '>=': number;
+    '<': number;
+    '<=': number;
+    hasAnyOf: number[];
+    hasNoneOf: number[];
+};
+type NumberAggregations = {
+    sum: number;
+    average: number;
+    median: number;
+    min: number | null;
+    max: number | null;
+    range: number;
+    standardDeviation: number;
+    histogram: Record<string, number>;
+    empty: number;
+    filled: number;
+    unique: number;
+    percentEmpty: number;
+    percentFilled: number;
+    percentUnique: number;
+};
+type CheckboxFilters = {
+    '=': number;
+};
+/**
+ *
+ * Column types
+ *
+ */
+export type ColumnType<S, U, I, R extends boolean, F extends {
+    [key: string]: any;
+} = object, A extends {
+    [key: string]: any;
+} = object> = {
     raw: S;
     insert: I;
     update: U;
-    type: T;
+    filters: F;
+    aggregations: A;
+    isRequired: R;
 };
-export type TextColumnType = ColumnType<string | undefined, string | undefined, string | null, 'text'>;
-export type LinkColumnType<T extends string> = ColumnType<object, number[] | {
-    newIds: number[];
-    deletedIds: number[];
-} | undefined, number[] | undefined, 'link'> & {
+export type DateColumnType<R extends boolean> = ColumnType<string, string, string, R, DateFilters, DateAggregations>;
+export type TextColumnType<R extends boolean> = ColumnType<string, string, string, R, TextFilters>;
+export type ALinkColumnType<T extends string, S, U, I, R extends boolean> = ColumnType<S, U, I, R, LinkFilters, LinkAggregations> & {
     linkedTo: T;
 };
-export type NumberColumnType = ColumnType<number | undefined, number | undefined, number | undefined, 'number'>;
-export type CheckboxColumnType = ColumnType<boolean | undefined, boolean | undefined, boolean | undefined, 'checkbox'>;
+export type LinkColumnType<T extends string, R extends boolean> = ALinkColumnType<T, object, number | number[] | {
+    newIds: number[];
+    deletedIds: number[];
+}, number | number[], R>;
+export type AttachmentColumnType<R extends boolean> = ALinkColumnType<'attachmentTable', Attachment[], Attachment[] | {
+    newIds: number[];
+    deletedIds: number[];
+} | number[], Attachment[] | number[], R>;
+export type NumberColumnType<R extends boolean> = ColumnType<number, number, number, R, NumberFilters, NumberAggregations>;
+export type CheckboxColumnType<R extends boolean> = ColumnType<boolean, boolean, boolean, R, CheckboxFilters>;
+export type AutoGeneratedNumberColumnType = ColumnType<number, never, never, false, NumberFilters, NumberAggregations>;
+export type AutoGeneratedDateColumnType = ColumnType<string, never, never, false, DateFilters, DateAggregations>;
+export {};

package/dist/esm/column-types.js

@@ -4,5 +4,27 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export {};
+export class Attachment {
+    collectionName;
+    fileInformation;
+    metadata;
+    baseId;
+    storageAdaptor;
+    _id;
+    constructor(data) {
+        this.collectionName = data.collectionName;
+        this.fileInformation = data.fileInformation;
+        this.metadata = data.metadata;
+        this.baseId = data.baseId;
+        this.storageAdaptor = data.storageAdaptor;
+        this._id = data._id;
+    }
+    toColumnValue() {
+        return {
+            url: this.fileInformation.path,
+            fileType: this.fileInformation.mimetype,
+            size: this.fileInformation.size,
+        };
+    }
+}
 //# sourceMappingURL=column-types.js.map

package/dist/esm/column-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"column-types.js","sourceRoot":"","sources":["../../src/column-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}
+{"version":3,"file":"column-types.js","sourceRoot":"","sources":["../../src/column-types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAmCH,MAAM,OAAO,UAAU;IACL,cAAc,CAAS;IACvB,eAAe,CAAkB;IACjC,QAAQ,CAAsC;IAC9C,MAAM,CAAS;IACf,cAAc,CAAS;IACvB,GAAG,CAAS;IAE5B,YAAY,IAAoB;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;IACtB,CAAC;IAED,aAAa;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;YAC9B,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ;YACvC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;SAChC,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -1,5 +1,4 @@
 export * from './@types/index.js';
 export * from './column-types.js';
 export * from './constants/index.js';
-export * from './table-types.js';
 export * from './utilities/index.js';

package/dist/esm/index.js

@@ -1,6 +1,5 @@
 export * from './@types/index.js';
 export * from './column-types.js';
 export * from './constants/index.js';
-export * from './table-types.js';
 export * from './utilities/index.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC"}