@aptly-as/types 2.5.3 → 2.5.4

package/core/api.d.ts

@@ -1,13 +1,13 @@
-export interface AptlySearchPaginateResponse<T> {
-    limit: number;
-    skip: number;
-    data: T[];
-    count: number;
-}
-export interface AptlyApiQueries {
-    limit?: number;
-    skip?: number;
-    text?: string;
-    select?: string;
-    populate?: string;
-}
+export interface AptlySearchPaginateResponse<T> {
+    limit: number;
+    skip: number;
+    data: T[];
+    count: number;
+}
+export interface AptlyApiQueries {
+    limit?: number;
+    skip?: number;
+    text?: string;
+    select?: string;
+    populate?: string;
+}

package/core/api.js

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

package/core/app.d.ts

@@ -1,37 +1,37 @@
-import { AptlyAppScope } from './scope.js';
-import { AptlyApp, AptlyOrganization, AptlyOrganizationAppConfig } from '../models/index.js';
-export declare enum AptlyAppSandbox {
-    AllowForms = "allow-forms",
-    AllowPopups = "allow-popups",
-    AllowScripts = "allow-scripts",
-    AllowSameOrigin = "allow-same-origin",
-    AllowPointerLock = "allow-pointer-lock",
-    AllowTopNavigation = "allow-top-navigation"
-}
-export interface AptlyAppJWT {
-    exp: number;
-}
-export interface AptlyAppAuthorizeCode {
-    jti: string;
-    aud: string;
-    sub: string;
-    iss: 'aptly.as';
-    organization: string;
-    app: string;
-    scope: AptlyAppScope[];
-}
-export interface AptlyAppAuthorizeToken extends Omit<AptlyAppAuthorizeCode, 'aud'> {
-    aud: string;
-}
-export interface AptlyAppWebContext<S extends object> {
-    organization: Pick<AptlyOrganization, '_id' | 'slug' | 'name'>;
-    project?: string;
-    unit?: string;
-    app: AptlyApp;
-    config: AptlyOrganizationAppConfig<S>;
-    theme: any;
-    media: AptlyAppWebContextMedia;
-}
-export interface AptlyAppWebContextMedia {
-    cloudinaryKey: string;
-}
+import { AptlyAppScope } from './scope.js';
+import { AptlyApp, AptlyOrganization, AptlyOrganizationAppConfig } from '../models/index.js';
+export declare enum AptlyAppSandbox {
+    AllowForms = "allow-forms",
+    AllowPopups = "allow-popups",
+    AllowScripts = "allow-scripts",
+    AllowSameOrigin = "allow-same-origin",
+    AllowPointerLock = "allow-pointer-lock",
+    AllowTopNavigation = "allow-top-navigation"
+}
+export interface AptlyAppJWT {
+    exp: number;
+}
+export interface AptlyAppAuthorizeCode {
+    jti: string;
+    aud: string;
+    sub: string;
+    iss: 'aptly.as';
+    organization: string;
+    app: string;
+    scope: AptlyAppScope[];
+}
+export interface AptlyAppAuthorizeToken extends Omit<AptlyAppAuthorizeCode, 'aud'> {
+    aud: string;
+}
+export interface AptlyAppWebContext<S extends object> {
+    organization: Pick<AptlyOrganization, '_id' | 'slug' | 'name'>;
+    project?: string;
+    unit?: string;
+    app: AptlyApp;
+    config: AptlyOrganizationAppConfig<S>;
+    theme: any;
+    media: AptlyAppWebContextMedia;
+}
+export interface AptlyAppWebContextMedia {
+    cloudinaryKey: string;
+}

package/core/app.js

@@ -1,9 +1,9 @@
-export var AptlyAppSandbox;
-(function (AptlyAppSandbox) {
-    AptlyAppSandbox["AllowForms"] = "allow-forms";
-    AptlyAppSandbox["AllowPopups"] = "allow-popups";
-    AptlyAppSandbox["AllowScripts"] = "allow-scripts";
-    AptlyAppSandbox["AllowSameOrigin"] = "allow-same-origin";
-    AptlyAppSandbox["AllowPointerLock"] = "allow-pointer-lock";
-    AptlyAppSandbox["AllowTopNavigation"] = "allow-top-navigation";
-})(AptlyAppSandbox || (AptlyAppSandbox = {}));
+export var AptlyAppSandbox;
+(function (AptlyAppSandbox) {
+    AptlyAppSandbox["AllowForms"] = "allow-forms";
+    AptlyAppSandbox["AllowPopups"] = "allow-popups";
+    AptlyAppSandbox["AllowScripts"] = "allow-scripts";
+    AptlyAppSandbox["AllowSameOrigin"] = "allow-same-origin";
+    AptlyAppSandbox["AllowPointerLock"] = "allow-pointer-lock";
+    AptlyAppSandbox["AllowTopNavigation"] = "allow-top-navigation";
+})(AptlyAppSandbox || (AptlyAppSandbox = {}));

package/core/cloudinary.d.ts

@@ -1,2 +1,2 @@
-import * as cloudinary from 'cloudinary';
-export type AptlyCloudinaryFile = cloudinary.UploadApiResponse;
+import * as cloudinary from 'cloudinary';
+export type AptlyCloudinaryFile = cloudinary.UploadApiResponse;

package/core/cloudinary.js

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

package/core/fields.d.ts

@@ -1,19 +1,19 @@
-import { AptlyFieldType } from '../enums/index.js';
-export type AptlyDraftJS = string;
-export type AptlyMarkdown = string;
-export interface AptlyField<L = string> {
-    type: AptlyFieldType;
-    label: L;
-    placeholder?: string;
-    required?: boolean;
-    pattern?: string;
-    autoComplete?: string;
-    disabled?: boolean;
-    multiple?: boolean;
-    autoFocus?: boolean;
-    options: AptlyFieldOption[];
-}
-export interface AptlyFieldOption<V extends string = string> {
-    value: V;
-    label: string;
-}
+import { AptlyFieldType } from '../enums/index.js';
+export type AptlyDraftJS = string;
+export type AptlyMarkdown = string;
+export interface AptlyField<L = string> {
+    type: AptlyFieldType;
+    label: L;
+    placeholder?: string;
+    required?: boolean;
+    pattern?: string;
+    autoComplete?: string;
+    disabled?: boolean;
+    multiple?: boolean;
+    autoFocus?: boolean;
+    options: AptlyFieldOption[];
+}
+export interface AptlyFieldOption<V extends string = string> {
+    value: V;
+    label: string;
+}

package/core/fields.js

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

package/core/index.d.ts

@@ -1,16 +1,16 @@
-import { AptlyDocumentS3 } from '../models/index.js';
-import { AptlyCloudinaryFile } from './cloudinary.js';
-export * from './api.js';
-export * from './app.js';
-export * from './cloudinary.js';
-export * from './job.js';
-export * from './redirect.js';
-export * from './scope.js';
-export * from './fields.js';
-export * from './signage.js';
-export * from './webhook-event-data.js';
-export interface AptlySchemaFile<ID> extends Pick<AptlyCloudinaryFile, 'public_id' | 'url' | 'format' | 'resource_type' | 'bytes'> {
-    filename: string;
-    s3?: AptlyDocumentS3;
-    document?: ID;
-}
+import { AptlyDocumentS3 } from '../models/index.js';
+import { AptlyCloudinaryFile } from './cloudinary.js';
+export * from './api.js';
+export * from './app.js';
+export * from './cloudinary.js';
+export * from './job.js';
+export * from './redirect.js';
+export * from './scope.js';
+export * from './fields.js';
+export * from './signage.js';
+export * from './webhook-event-data.js';
+export interface AptlySchemaFile<ID> extends Pick<AptlyCloudinaryFile, 'public_id' | 'url' | 'format' | 'resource_type' | 'bytes'> {
+    filename: string;
+    s3?: AptlyDocumentS3;
+    document?: ID;
+}

package/core/index.js

@@ -1,9 +1,9 @@
-export * from './api.js';
-export * from './app.js';
-export * from './cloudinary.js';
-export * from './job.js';
-export * from './redirect.js';
-export * from './scope.js';
-export * from './fields.js';
-export * from './signage.js';
-export * from './webhook-event-data.js';
+export * from './api.js';
+export * from './app.js';
+export * from './cloudinary.js';
+export * from './job.js';
+export * from './redirect.js';
+export * from './scope.js';
+export * from './fields.js';
+export * from './signage.js';
+export * from './webhook-event-data.js';

package/core/job.d.ts

@@ -1,21 +1,21 @@
-import { AptlyOrder } from '../models/index.js';
-export declare enum AptlyJobQueue {
-    Documents = "documents",
-    Orders = "orders",
-    Units = "units"
-}
-export declare enum AptlyJobName {
-    ZipDocuments = "zip-documents",
-    Create = "create"
-}
-export interface AptlyJob<DATA = any, RETURN = any> {
-    id: string;
-    name: AptlyJobName;
-    progress: number;
-    data: DATA;
-    returnvalue: RETURN;
-    failedReason?: string;
-}
-export type AptlyJobOrder = AptlyJob<any, {
-    order: AptlyOrder;
-}>;
+import { AptlyOrder } from '../models/index.js';
+export declare enum AptlyJobQueue {
+    Documents = "documents",
+    Orders = "orders",
+    Units = "units"
+}
+export declare enum AptlyJobName {
+    ZipDocuments = "zip-documents",
+    Create = "create"
+}
+export interface AptlyJob<DATA = any, RETURN = any> {
+    id: string;
+    name: AptlyJobName;
+    progress: number;
+    data: DATA;
+    returnvalue: RETURN;
+    failedReason?: string;
+}
+export type AptlyJobOrder = AptlyJob<any, {
+    order: AptlyOrder;
+}>;

package/core/job.js

@@ -1,11 +1,11 @@
-export var AptlyJobQueue;
-(function (AptlyJobQueue) {
-    AptlyJobQueue["Documents"] = "documents";
-    AptlyJobQueue["Orders"] = "orders";
-    AptlyJobQueue["Units"] = "units";
-})(AptlyJobQueue || (AptlyJobQueue = {}));
-export var AptlyJobName;
-(function (AptlyJobName) {
-    AptlyJobName["ZipDocuments"] = "zip-documents";
-    AptlyJobName["Create"] = "create";
-})(AptlyJobName || (AptlyJobName = {}));
+export var AptlyJobQueue;
+(function (AptlyJobQueue) {
+    AptlyJobQueue["Documents"] = "documents";
+    AptlyJobQueue["Orders"] = "orders";
+    AptlyJobQueue["Units"] = "units";
+})(AptlyJobQueue || (AptlyJobQueue = {}));
+export var AptlyJobName;
+(function (AptlyJobName) {
+    AptlyJobName["ZipDocuments"] = "zip-documents";
+    AptlyJobName["Create"] = "create";
+})(AptlyJobName || (AptlyJobName = {}));

package/core/redirect.d.ts

@@ -1,17 +1,17 @@
-export declare enum AptlyRedirectAction {
-    Sign = "sign",
-    Payment = "payment"
-}
-export declare enum AptlyRedirectActionError {
-    SignCancel = "signCancel",
-    SignError = "signError",
-    Cancel = "cancel",
-    Error = "error"
-}
-export type AptlyRedirectOptions = {
-    action: AptlyRedirectAction;
-    error?: AptlyRedirectActionError;
-    error_description?: string;
-};
-export type AptlyClientRedirectOptions = Record<'unit', string> & Partial<Record<'period', string>> & AptlyRedirectOptions;
-export type AptlyDashboardRedirectOptions = Record<'organization' | 'project', string> & AptlyRedirectOptions;
+export declare enum AptlyRedirectAction {
+    Sign = "sign",
+    Payment = "payment"
+}
+export declare enum AptlyRedirectActionError {
+    SignCancel = "signCancel",
+    SignError = "signError",
+    Cancel = "cancel",
+    Error = "error"
+}
+export type AptlyRedirectOptions = {
+    action: AptlyRedirectAction;
+    error?: AptlyRedirectActionError;
+    error_description?: string;
+};
+export type AptlyClientRedirectOptions = Record<'unit', string> & Partial<Record<'period', string>> & AptlyRedirectOptions;
+export type AptlyDashboardRedirectOptions = Record<'organization' | 'project', string> & AptlyRedirectOptions;

package/core/redirect.js

@@ -1,12 +1,12 @@
-export var AptlyRedirectAction;
-(function (AptlyRedirectAction) {
-    AptlyRedirectAction["Sign"] = "sign";
-    AptlyRedirectAction["Payment"] = "payment";
-})(AptlyRedirectAction || (AptlyRedirectAction = {}));
-export var AptlyRedirectActionError;
-(function (AptlyRedirectActionError) {
-    AptlyRedirectActionError["SignCancel"] = "signCancel";
-    AptlyRedirectActionError["SignError"] = "signError";
-    AptlyRedirectActionError["Cancel"] = "cancel";
-    AptlyRedirectActionError["Error"] = "error";
-})(AptlyRedirectActionError || (AptlyRedirectActionError = {}));
+export var AptlyRedirectAction;
+(function (AptlyRedirectAction) {
+    AptlyRedirectAction["Sign"] = "sign";
+    AptlyRedirectAction["Payment"] = "payment";
+})(AptlyRedirectAction || (AptlyRedirectAction = {}));
+export var AptlyRedirectActionError;
+(function (AptlyRedirectActionError) {
+    AptlyRedirectActionError["SignCancel"] = "signCancel";
+    AptlyRedirectActionError["SignError"] = "signError";
+    AptlyRedirectActionError["Cancel"] = "cancel";
+    AptlyRedirectActionError["Error"] = "error";
+})(AptlyRedirectActionError || (AptlyRedirectActionError = {}));

package/core/scope.d.ts

@@ -1,124 +1,124 @@
-export declare enum AptlyModules {
-    Algorithms = "algorithms",
-    Booking = "booking",
-    Core = "core",
-    Default = "default",
-    Departments = "departments",
-    Emails = "emails",
-    OptionLabels = "optionLabels",
-    Pages = "pages",
-    Payment = "payment",
-    ProductsExtended = "productsExtended",
-    Recommendations = "recommendations",
-    Signing = "signing",
-    Support = "support",
-    SupportComplaint = "supportComplaint",
-    Testing = "testing",
-    ThirdParty = "thirdParty",
-    UnitExtraOptions = "unitExtraOptions",
-    UnitExtraFields = "unitExtraFields"
-}
-export declare enum AptlyScopes {
-    Admin = "admin",
-    AdminApps = "adminApps",
-    AdminBilling = "adminBilling",
-    AdminModules = "adminModules",
-    AdminProducers = "adminProducers",
-    AdminProducts = "adminProducts",
-    AdminReport = "adminReport",
-    AdminStats = "adminStats",
-    AdminSuppliers = "adminSuppliers",
-    AdminTags = "adminTags",
-    AdminTesting = "adminTesting",
-    AdminUsers = "adminUsers",
-    AdminOrganizations = "adminOrganizations",
-    Beta = "beta",
-    Organization = "organization",
-    OrganizationAlgorithms = "organizationAlgorithms",
-    OrganizationBooking = "organizationBooking",
-    OrganizationClients = "organizationClients",
-    OrganizationDepartments = "organizationDepartments",
-    OrganizationLogo = "organizationLogo",
-    OrganizationMembers = "organizationMembers",
-    OrganizationOptionLabels = "organizationOptionLabels",
-    OrganizationOrders = "organizationOrders",
-    OrganizationPayment = "organizationPayment",
-    OrganizationPages = "organizationPages",
-    OrganizationProducts = "organizationProducts",
-    OrganizationProductsExtended = "organizationProductsExtended",
-    OrganizationRecommendations = "organizationRecommendations",
-    OrganizationReport = "organizationReport",
-    OrganizationStats = "organizationStats",
-    OrganizationUnitTemplates = "organizationUnitTemplates",
-    OrganizationUpsellTemplates = "organizationUpsellTemplates",
-    OrganizationWebhooks = "organizationWebhooks",
-    Project = "project",
-    ProjectAlgorithms = "projectAlgorithms",
-    ProjectBooking = "projectBooking",
-    ProjectDocuments = "projectDocuments",
-    ProjectEmails = "projectEmails",
-    ProjectInquiry = "projectInquiry",
-    ProjectInquiryComplaint = "projectInquiryComplaint",
-    ProjectOrders = "projectOrders",
-    ProjectPayment = "projectPayment",
-    ProjectPages = "projectPages",
-    ProjectPeriods = "projectPeriods",
-    ProjectProducts = "projectProducts",
-    ProjectRecommendations = "projectRecommendations",
-    ProjectReport = "projectReport",
-    ProjectReportPrice = "projectReportPrice",
-    ProjectTheme = "projectTheme",
-    ProjectSigning = "projectSigning",
-    ProjectThirdParty = "projectThirdParty",
-    ProjectUnits = "projectUnits",
-    ProjectUnitInvites = "projectUnitInvites",
-    ProjectUnitExtraFields = "projectUnitExtraFields",
-    ProjectUnitExtraOptions = "projectUnitExtraOptions",
-    ProjectUnitDocuments = "projectUnitDocuments",
-    ProjectUnitTemplates = "projectUnitTemplates",
-    ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
-    ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",
-    ProjectUpsellTemplates = "projectUpsellTemplates",
-    Unit = "unit",
-    UnitBooking = "unitBooking",
-    UnitInquiry = "unitInquiry",
-    UnitNotes = "unitNotes",
-    UnitOrders = "unitOrders",
-    UnitPages = "unitPages",
-    UnitProducts = "unitProducts",
-    UnitReport = "unitReport"
-}
-export declare enum AptlyUserRoles {
-    Admin = "admin",
-    Beta = "beta",
-    Default = "default",
-    SuperAdmin = "superAdmin"
-}
-export declare enum AptlyOrganizationRoles {
-    Admin = "admin",
-    Content = "content",
-    Default = "default",
-    Orders = "orders",
-    OrganizationContent = "organizationContent",
-    ProjectAdmin = "projectAdmin",
-    Reports = "reports",
-    Support = "support",
-    TestingAdmin = "testingAdmin",
-    ThirdParty = "thirdParty"
-}
-export type AptlyScopeCrud = 'C' | 'R' | 'U' | 'D';
-export type AptlyScopeSchemaValue = 'C' | 'CR' | 'CRU' | 'CRUD' | 'R' | 'RU' | 'RUD' | 'U' | 'UD' | 'D';
-export type AptlyScopeSchema = {
-    [key in AptlyScopes]: AptlyScopeSchemaValue;
-};
-export declare enum AptlyScopeAction {
-    Read = "read",
-    Write = "write"
-}
-export type AptlyAppScope = `aptly.${AptlyScopes}` | `aptly.${AptlyScopes}.${AptlyScopeAction}`;
-export type AptlyAppScopeTranslations = {
-    [key in AptlyAppScope]: {
-        label: string;
-        description?: string;
-    };
-};
+export declare enum AptlyModules {
+    Algorithms = "algorithms",
+    Booking = "booking",
+    Core = "core",
+    Default = "default",
+    Departments = "departments",
+    Emails = "emails",
+    OptionLabels = "optionLabels",
+    Pages = "pages",
+    Payment = "payment",
+    ProductsExtended = "productsExtended",
+    Recommendations = "recommendations",
+    Signing = "signing",
+    Support = "support",
+    SupportComplaint = "supportComplaint",
+    Testing = "testing",
+    ThirdParty = "thirdParty",
+    UnitExtraOptions = "unitExtraOptions",
+    UnitExtraFields = "unitExtraFields"
+}
+export declare enum AptlyScopes {
+    Admin = "admin",
+    AdminApps = "adminApps",
+    AdminBilling = "adminBilling",
+    AdminModules = "adminModules",
+    AdminProducers = "adminProducers",
+    AdminProducts = "adminProducts",
+    AdminReport = "adminReport",
+    AdminStats = "adminStats",
+    AdminSuppliers = "adminSuppliers",
+    AdminTags = "adminTags",
+    AdminTesting = "adminTesting",
+    AdminUsers = "adminUsers",
+    AdminOrganizations = "adminOrganizations",
+    Beta = "beta",
+    Organization = "organization",
+    OrganizationAlgorithms = "organizationAlgorithms",
+    OrganizationBooking = "organizationBooking",
+    OrganizationClients = "organizationClients",
+    OrganizationDepartments = "organizationDepartments",
+    OrganizationLogo = "organizationLogo",
+    OrganizationMembers = "organizationMembers",
+    OrganizationOptionLabels = "organizationOptionLabels",
+    OrganizationOrders = "organizationOrders",
+    OrganizationPayment = "organizationPayment",
+    OrganizationPages = "organizationPages",
+    OrganizationProducts = "organizationProducts",
+    OrganizationProductsExtended = "organizationProductsExtended",
+    OrganizationRecommendations = "organizationRecommendations",
+    OrganizationReport = "organizationReport",
+    OrganizationStats = "organizationStats",
+    OrganizationUnitTemplates = "organizationUnitTemplates",
+    OrganizationUpsellTemplates = "organizationUpsellTemplates",
+    OrganizationWebhooks = "organizationWebhooks",
+    Project = "project",
+    ProjectAlgorithms = "projectAlgorithms",
+    ProjectBooking = "projectBooking",
+    ProjectDocuments = "projectDocuments",
+    ProjectEmails = "projectEmails",
+    ProjectInquiry = "projectInquiry",
+    ProjectInquiryComplaint = "projectInquiryComplaint",
+    ProjectOrders = "projectOrders",
+    ProjectPayment = "projectPayment",
+    ProjectPages = "projectPages",
+    ProjectPeriods = "projectPeriods",
+    ProjectProducts = "projectProducts",
+    ProjectRecommendations = "projectRecommendations",
+    ProjectReport = "projectReport",
+    ProjectReportPrice = "projectReportPrice",
+    ProjectTheme = "projectTheme",
+    ProjectSigning = "projectSigning",
+    ProjectThirdParty = "projectThirdParty",
+    ProjectUnits = "projectUnits",
+    ProjectUnitInvites = "projectUnitInvites",
+    ProjectUnitExtraFields = "projectUnitExtraFields",
+    ProjectUnitExtraOptions = "projectUnitExtraOptions",
+    ProjectUnitDocuments = "projectUnitDocuments",
+    ProjectUnitTemplates = "projectUnitTemplates",
+    ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
+    ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",
+    ProjectUpsellTemplates = "projectUpsellTemplates",
+    Unit = "unit",
+    UnitBooking = "unitBooking",
+    UnitInquiry = "unitInquiry",
+    UnitNotes = "unitNotes",
+    UnitOrders = "unitOrders",
+    UnitPages = "unitPages",
+    UnitProducts = "unitProducts",
+    UnitReport = "unitReport"
+}
+export declare enum AptlyUserRoles {
+    Admin = "admin",
+    Beta = "beta",
+    Default = "default",
+    SuperAdmin = "superAdmin"
+}
+export declare enum AptlyOrganizationRoles {
+    Admin = "admin",
+    Content = "content",
+    Default = "default",
+    Orders = "orders",
+    OrganizationContent = "organizationContent",
+    ProjectAdmin = "projectAdmin",
+    Reports = "reports",
+    Support = "support",
+    TestingAdmin = "testingAdmin",
+    ThirdParty = "thirdParty"
+}
+export type AptlyScopeCrud = 'C' | 'R' | 'U' | 'D';
+export type AptlyScopeSchemaValue = 'C' | 'CR' | 'CRU' | 'CRUD' | 'R' | 'RU' | 'RUD' | 'U' | 'UD' | 'D';
+export type AptlyScopeSchema = {
+    [key in AptlyScopes]: AptlyScopeSchemaValue;
+};
+export declare enum AptlyScopeAction {
+    Read = "read",
+    Write = "write"
+}
+export type AptlyAppScope = `aptly.${AptlyScopes}` | `aptly.${AptlyScopes}.${AptlyScopeAction}`;
+export type AptlyAppScopeTranslations = {
+    [key in AptlyAppScope]: {
+        label: string;
+        description?: string;
+    };
+};