@dizmo/dcs-client-library 4.0.1

package/dist/types/types.d.ts

@@ -0,0 +1,589 @@
+import type { TranslateTextOptions } from "deepl-node";
+export type Filter = {
+    equals: [string, boolean | string | number | null];
+} | {
+    greater: [string, number | string];
+} | {
+    greaterOrEqual: [string, number | string];
+} | {
+    less: [string, number | string];
+} | {
+    lessOrEqual: [string, number | string];
+} | {
+    stringContains: [string, string];
+} | {
+    arrayContains: [string, string | number | null | boolean];
+} | {
+    length: [string, number];
+} | {
+    startsWith: [string, string];
+} | {
+    endsWith: [string, string];
+} | {
+    and: Filter[];
+} | {
+    or: Filter[];
+} | {
+    not: Filter;
+} | null;
+export type AllocationFilter = {
+    root?: Filter;
+    relationship?: Filter;
+    leaf?: Filter;
+};
+export type Input = {
+    [property: string]: any;
+};
+export type ItemOptions = {
+    markAbsent?: {
+        from: number;
+        to: number;
+    };
+    allocatable?: {
+        templateSearch: string;
+        item: string;
+        from: number;
+        to: number;
+    };
+    table?: "auth_user";
+    start?: number;
+    count?: number;
+};
+export type AllocFilter = {
+    root?: Filter;
+    relationship?: Filter;
+    leaf?: Filter;
+};
+export type AllocSort = {
+    root?: Sort[];
+    relationship?: Sort[];
+    leaf?: Sort[];
+};
+export type AllocOptions = {
+    spreadAllocations?: boolean;
+    includeConsolidatedAllocations?: boolean;
+    checkAllocationRules?: boolean;
+    includeFreeItems?: boolean;
+    includeConcurrent?: boolean;
+    start?: number;
+    count?: number;
+    relationship?: {
+        start?: number;
+        count?: number;
+    };
+};
+export type Sort = {
+    attribute: string;
+    ascending: boolean;
+};
+export type BulkCommand = {
+    create?: CreateAllocBulk[];
+    update?: UpdateAllocBulk[];
+    delete?: string[];
+};
+export type CreateAllocBulk = {
+    from: number;
+    to: number;
+    item1Id: string;
+    item2Id: string;
+    name?: string;
+};
+export type UpdateAllocBulk = {
+    allocId: string;
+    from?: number;
+    to?: number;
+    item1Id?: string;
+    item2Id?: string;
+    name?: string;
+};
+export type UpdateAlloc = {
+    from?: number;
+    to?: number;
+    name?: string;
+};
+export type CreateAlloc = {
+    from: number;
+    to: number;
+    name?: string;
+    timezone?: string;
+};
+export type DevErrorCollection = {
+    [errName: string]: {
+        message: string;
+        number: number;
+    };
+};
+export type LanguageObj = {
+    [key: string]: string;
+};
+export type StringParams = {
+    [param: string]: string | number;
+};
+export type UserErrorCollection = {
+    [property: string]: string;
+};
+export type ErrorParams = {
+    [param: string]: string | number;
+};
+export type RawErrorData = {
+    [language: string]: UserErrorCollection;
+};
+export type FullError = {
+    [errName: string]: {
+        errorName: string;
+        userMessage: string;
+        devMessage: string;
+        errorNumber: number;
+    };
+};
+export type TemplateFilter = {
+    name?: string;
+    root?: {
+        name: string;
+    };
+};
+export type ExportSettings = {
+    timezone?: string;
+    items?: ExportItemsConfig;
+    allocations?: ExportAllocConfig;
+};
+export type ExportItemsConfig = string | string[];
+export type ExportAllocConfig = string | {
+    all: {
+        [itemType: string]: string;
+    };
+} | {
+    primary: {
+        itemType1: string;
+    };
+    secondary: {
+        [itemType: string]: string;
+    };
+};
+export type UpdateCalendarInfo = {
+    day?: string;
+    text?: {
+        [key: string]: string;
+    };
+    textColor?: string;
+    bgColor?: string;
+    overlayColor?: string;
+    freeTime?: boolean;
+};
+export type GetCalendarOptions = {
+    id?: string;
+    start?: string;
+    end?: string;
+};
+export type CalendarInfo = {
+    day: string;
+    text: {
+        [key: string]: string;
+    };
+    textColor: string;
+    bgColor: string;
+    overlayColor: string;
+    freeTime: boolean;
+};
+export type RepetitionInfo = {
+    pattern: "day" | "week" | "month_weekday" | "month_date" | "year_occurrence" | "year_date" | "on_certain_days";
+    durationType: "on" | "after";
+    durationValue: number;
+    originalId?: string;
+    days_of_the_week?: string[];
+    skip_weekends?: boolean;
+};
+export type EditOrDeletionType = "this" | "future" | "all" | "past";
+export type PackageFilter = {
+    name?: string;
+    template?: string;
+};
+export type UpdatePackage = {
+    name?: string;
+    description?: string;
+};
+export type CreatePackage = {
+    name: string;
+    description: string;
+    rootItemTypeId: string;
+    packageAllocations: PackageAlloc[];
+    originalPackageDate?: number;
+};
+export type PackageAlloc = {
+    startOffset: number;
+    duration: number;
+    leafId: string;
+};
+export type FullPackageAlloc = {
+    startOffset: number;
+    duration: number;
+    leafId: string;
+    leafData: ItemResult | null;
+};
+export type ItemResult = {
+    labels: string[];
+    properties: {
+        id: string;
+        _created_by: string;
+        _edited_by: string;
+        isAbsent?: boolean;
+        [prop: string]: any;
+    };
+    _datatype?: "item";
+};
+export type NeedResult = {
+    _id: string;
+    _created_by?: string;
+    _edited_by?: string;
+    _datatype: "need";
+    type: string;
+    name: string;
+    filter: Filter;
+};
+export type CreateResult = {
+    properties: {
+        id: string;
+    };
+};
+export type Allocation = {
+    properties: {
+        id: string;
+        from: number;
+        to: number;
+        _created_by?: string;
+        _edited_by?: string;
+        name?: string;
+        _repetitionId?: string;
+        overbooked?: boolean;
+        pivotOverbooked?: boolean;
+    };
+};
+export type AllocationResult = {
+    root: ItemResult;
+    relationships: AllocationRelationship[];
+};
+export type AllocationRelationship = {
+    leaf: ItemResult;
+    allocations: Allocation[];
+};
+export type SpreadAllocationRelationship = {
+    leaf: ItemResult;
+    allocation: Allocation;
+};
+export type SpreadAllocationResult = {
+    root: ItemResult;
+    relationships: SpreadAllocationRelationship[];
+};
+export type AllocationResult3 = {
+    root: ItemResult | NeedResult;
+    relationships: AllocationRelationship3[];
+};
+export type AllocationRelationship3 = {
+    leaf: ItemResult | NeedResult;
+    allocations: Allocation[];
+};
+export type SpreadAllocationRelationship3 = {
+    leaf: ItemResult | NeedResult;
+    allocation: Allocation;
+};
+export type SpreadAllocationResult3 = {
+    root: ItemResult | NeedResult;
+    relationships: SpreadAllocationRelationship3[];
+};
+export type RepetitionCreateResult = {
+    _repetitionId: string;
+};
+export type TemplateAttributeResult = {
+    default_value: number | string | boolean | string[] | {
+        long: number;
+        lat: number;
+    } | null;
+    editable_by: Permissions;
+    id: string;
+    label: {
+        [language: string]: string;
+    };
+    type: string;
+    value_type: string;
+    options: any;
+    visible_by: Permissions;
+};
+export type TemplateSettingsResult = {
+    card_first_line: string;
+    card_second_line: string;
+    id_dizmoauthid?: string;
+    sort?: string;
+    icon_url: string;
+    confirm_changes_popup: boolean;
+    individual_color: string;
+    createable_by: Permissions;
+    deleteable_by: Permissions;
+    allocateable_by: Permissions;
+};
+export type TemplateResult = {
+    _created_by: string;
+    _edited_by: string;
+    attributes: TemplateAttributeResult[];
+    color: string;
+    id: string;
+    options: any;
+    settings: TemplateSettingsResult | null;
+    title: {
+        [key: string]: string;
+    };
+    type: string;
+};
+export type RawTemplate = {
+    properties: {
+        id: string;
+        type: string;
+        _created_by: string;
+        _edited_by: string;
+        data: string;
+    };
+};
+export type UserInfo = {
+    role: "admin" | "viewer" | "editor";
+    username: string;
+    company: string;
+    db_found: boolean;
+};
+export type CalendarResult = {
+    _id: string;
+    _created_by: string;
+    _edited_by: string;
+    day: string;
+    text: {
+        [lang: string]: string;
+    };
+    textColor: string;
+    bgColor: string;
+    overlayColor: string;
+    freeTime: boolean;
+};
+export type PackagesResult = {
+    _id: string;
+    _created_by: string;
+    _created_on: number;
+    _edited_by: string;
+    _last_used: number;
+    numberOfAllocations: number;
+    totalDuration: number;
+    name: string;
+    description: string;
+    originalPackageDate: number;
+    rootItemTypeId: string;
+    packageAllocations: PackageAlloc[];
+};
+export type PackageResult = {
+    _id: string;
+    _created_by: string;
+    _created_on: number;
+    _edited_by: string;
+    _last_used: number;
+    numberOfAllocations: number;
+    totalDuration: number;
+    name: string;
+    description: string;
+    originalPackageDate: number;
+    rootItemTypeId: string;
+    packageAllocations: FullPackageAlloc[];
+};
+export type CreateNeed = {
+    type: string;
+    name: string;
+    filter: Filter;
+};
+export type UpdateNeed = {
+    filter?: Filter;
+    name?: string;
+};
+export type Need = CreateNeed & {
+    _id: string;
+    _created_by: string;
+    _edited_by: string;
+    _datatype: "need";
+};
+export type GetNeeds = {
+    type: string;
+};
+export type DeepLResponse = {
+    text: string;
+    detectedSourceLang: string;
+    billedCharacters: string;
+};
+export type ProcessedDeepLResponse = {
+    text: string;
+    detectedSourceLang: string;
+};
+export type DeepLInput = {
+    texts: string | string[];
+    sourceLang: string | null;
+    targetLang: string;
+    options?: TranslateTextOptions;
+};
+export type BulkOperationOptions = {
+    skipUndefined?: boolean;
+    type?: string;
+    [key: string]: unknown;
+};
+export type BulkOperationResult = {
+    success: boolean;
+    createdIds: string[];
+    updatedIds: string[];
+    deletedIds: string[];
+};
+export type CompanySettingsResult = {
+    properties: {
+        [key: string]: any;
+    };
+};
+export type NotificationInform = {
+    inform: "self";
+} | {
+    inform: "responsible";
+    responsibleAttribute: string;
+};
+export type NotificationRule = {
+    change: "alloc";
+    templateNotified: string;
+    templateOther: string;
+    notify: NotificationInform;
+} | {
+    change: "attribute";
+    templateChanged: string;
+    templateToInform: string | null;
+    notify: NotificationInform;
+};
+export type PermissionVar = {
+    userid: Record<string, never>;
+} | {
+    allocatedItemIds: Record<string, never>;
+};
+export type PermissionFilter = {
+    equals: [string, boolean | string | number | null | PermissionVar];
+} | {
+    greater: [string, number | string | PermissionVar];
+} | {
+    greaterOrEqual: [string, number | string | PermissionVar];
+} | {
+    less: [string, number | string | PermissionVar];
+} | {
+    lessOrEqual: [string, number | string | PermissionVar];
+} | {
+    stringContains: [string, string | PermissionVar];
+} | {
+    arrayContains: [string, string | number | null | boolean | PermissionVar];
+} | {
+    length: [string, number | PermissionVar];
+} | {
+    startsWith: [string, string | PermissionVar];
+} | {
+    endsWith: [string, string | PermissionVar];
+} | {
+    in: [string, PermissionVar | string[]];
+} | {
+    and: PermissionFilter[];
+} | {
+    or: PermissionFilter[];
+} | {
+    not: PermissionFilter;
+} | null;
+export type AccessPermission = {
+    match: PermissionFilter;
+    read: string[] | {
+        any: Record<string, never>;
+    };
+    write: string[] | {
+        any: Record<string, never>;
+    };
+    create: boolean;
+    delete: boolean;
+    visible: boolean;
+};
+export type AccessPermissions = {
+    [role: string]: {
+        items: AccessPermission[];
+        allocs: AccessPermission[];
+    };
+};
+export type CompanySettingsInput = {
+    allocationRules: {
+        [key: string]: number;
+    };
+    supported_languages?: string[];
+    default_language?: string;
+    _edited_by?: string;
+    name?: string;
+    company?: string;
+    notificationRules?: NotificationRule[];
+    notificationCoolDown?: number;
+    notificationSendIfSooner?: number;
+    notificationSendImmediately?: number;
+    accessPermissions?: AccessPermissions;
+    allocationPageSize?: number;
+};
+export type Permissions = ("editor" | "admin" | "viewer")[];
+export type TemplateAttributeInput = {
+    id: string;
+    label: {
+        [language: string]: string;
+    };
+    type: string;
+    default_value: number | string | boolean | string[] | {
+        long: number;
+        lat: number;
+    } | null;
+    editable_by: Permissions;
+    visible_by: Permissions;
+    options?: unknown;
+};
+export type TemplateSettingsInput = {
+    card_first_line?: string;
+    card_second_line?: string;
+    id_dizmoauthid?: string;
+    sort?: string;
+    icon_url?: string;
+    confirm_changes_popup?: boolean;
+    individual_color?: string;
+    createable_by?: Permissions;
+    allocateable_by?: Permissions;
+    deleteable_by?: Permissions;
+};
+export type TemplateInput = {
+    _id?: string;
+    type?: string;
+    color: string | null;
+    title: {
+        [language: string]: string;
+    };
+    options?: {
+        geometry?: {
+            width: number;
+            height: number;
+        };
+    };
+    settings: TemplateSettingsInput;
+    attributes: TemplateAttributeInput[];
+};
+export type RestoreResult = {
+    message: string;
+    id?: string;
+};
+export type UpdateResult = {
+    _id: string;
+};
+export type DeleteResult = Record<string, never>;
+export type CsvImportResult = {
+    message: string;
+    id?: string;
+};
+export type FileInfoResult = {
+    successOnAPI: boolean;
+    isDCSFile: boolean;
+    fileCategory: string | undefined;
+    fileType: string | null | undefined;
+    originalURL: string;
+    blobURL: string | undefined;
+    previewURL: string;
+};

package/dist/types/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@dizmo/dcs-client-library",
+  "version": "4.0.1",
+  "description": "A library that allows connection and management of dcs",
+  "source": "source/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"], 
+  "scripts": {
+    "test": "mocha source/test/**/*.js",
+    "build": "tsc",
+    "prepublishOnly": "tsc"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@dizmo/dizmo.js": "^1.4.77",
+    "prettier": "3.1.0",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "deepl-node": "^1.19.0"
+  }
+}