@clxmedia/types 1.0.3 → 1.0.4

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@clxmedia/types",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Conversion Logix TypeScript type definitions",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "typesVersions": {
     "*": {
       "credstore": [
-        "dist/credstore/index.d.ts"
+        "credstore/index.d.ts"
       ],
       "clxforms": [
-        "dist/clxforms/index.d.ts"
+        "clxforms/index.d.ts"
       ],
       "mediahub": [
-        "dist/mediahub/index.d.ts"
+        "mediahub/index.d.ts"
       ],
       "emailhub": [
-        "dist/emailhub/index.d.ts"
+        "emailhub/index.d.ts"
       ],
       "core": [
-        "dist/core/index.d.ts"
+        "core/index.d.ts"
       ]
     }
   },
@@ -27,7 +27,13 @@
     "build": "tsc"
   },
   "files": [
-    "dist"
+    "*.js",
+    "*.d.ts",
+    "credstore",
+    "clxforms",
+    "mediahub",
+    "emailhub",
+    "core"
   ],
   "devDependencies": {
     "typescript": "^5.2.2"

package/dist/clxforms/index.d.ts

@@ -1,206 +0,0 @@
-export type CLXFormSelectOption = {
-    value: string;
-    label: string;
-};
-export type CLXFormSelectOptions = CLXFormSelectOption[];
-export type CLXFormMode = 'edit' | 'preview' | 'live';
-export type CLXFormErrorMsg = string | null;
-export type CLXFormFormattingResponse = {
-    errorMsg: CLXFormErrorMsg[];
-    formattedValue: any | undefined;
-};
-export type CLXFormQuestionLocator = {
-    stepPosition: number;
-    sectionPosition: number;
-    questionSlug?: string;
-};
-export type CLXForm = {
-    id: number;
-    slug: string;
-    name: string;
-    description?: string;
-};
-export type CLXFormResponseType = 'STRING' | 'NUMBER' | 'STRING_ARRAY' | 'BOOLEAN' | 'ANY';
-export type CLXFormFieldType = 'text' | 'textarea' | 'boolean' | 'select' | 'multiselect';
-export type CLXFormSelectType = 'select' | 'radio' | 'checkbox' | 'freeform';
-export type CLXFormConditionSubjectEntry = {
-    value: string;
-    label: string;
-    responseType: CLXFormResponseType;
-    picklist?: CLXFormSelectOptions;
-};
-export type CLXFormResponseValueBase = {
-    type: CLXFormResponseType;
-    errorMsg?: CLXFormErrorMsg[];
-};
-export type CLXFormResponseStringValue = CLXFormResponseValueBase & {
-    type: 'STRING';
-    value: string;
-};
-export type CLXFormResponseNumberValue = CLXFormResponseValueBase & {
-    type: 'NUMBER';
-    value: number;
-};
-export type CLXFormResponseBooleanValue = CLXFormResponseValueBase & {
-    type: 'BOOLEAN';
-    value: boolean;
-};
-export type CLXFormResponseStringArrayValue = CLXFormResponseValueBase & {
-    type: 'STRING_ARRAY';
-    value: string[];
-};
-export type CLXFormResponseAnyValue = CLXFormResponseValueBase & {
-    type: 'ANY';
-    value: any;
-};
-export type CLXFormResponseValue = CLXFormResponseStringValue | CLXFormResponseStringArrayValue | CLXFormResponseNumberValue | CLXFormResponseBooleanValue | CLXFormResponseAnyValue;
-export type CLXFormResponses = {
-    [questionSlug: string]: CLXFormResponseValue;
-};
-export type CLXFormField = {
-    type: CLXFormFieldType;
-    response_type: CLXFormResponseType;
-};
-export type CLXFieldMasks = 'phone' | 'email' | 'name' | 'number' | 'none' | 'url';
-export type CLXPlainFormFieldBase = CLXFormField & {
-    type: 'text';
-    mask: CLXFieldMasks;
-};
-export type CLXTextFormFieldBase = CLXPlainFormFieldBase & {
-    type: 'text';
-    mask: 'phone' | 'email' | 'name' | 'url' | 'none';
-    response_type: 'STRING' | 'STRING_ARRAY';
-    multiple: boolean;
-};
-export type CLXTextFormField = CLXTextFormFieldBase & {
-    response_type: 'STRING';
-    multiple: false;
-};
-export type CLXMultipleTextFormField = CLXTextFormFieldBase & {
-    response_type: 'STRING_ARRAY';
-    multiple: true;
-};
-export type CLXNumberFormField = CLXPlainFormFieldBase & {
-    type: 'text';
-    mask: 'number';
-    response_type: 'NUMBER';
-    rounding?: number;
-};
-export type CLXTextAreaFormField = CLXFormField & {
-    type: 'textarea';
-    response_type: 'STRING';
-};
-export type CLXSelectableFormField = CLXFormField & {
-    select_type: CLXFormSelectType;
-};
-export type CLXBooleanFormField = CLXSelectableFormField & {
-    type: 'boolean';
-    select_type: 'select' | 'radio';
-    response_type: 'BOOLEAN';
-};
-export type CLXSelectFormField = CLXSelectableFormField & {
-    type: 'select';
-    response_type: 'STRING';
-    select_type: 'select' | 'radio';
-    options: CLXFormSelectOptions;
-};
-export type CLXMultiSelectFormField = CLXSelectableFormField & {
-    type: 'multiselect';
-    response_type: 'STRING_ARRAY';
-    select_type: 'checkbox' | 'freeform';
-    options: CLXFormSelectOptions;
-    max_select?: number;
-};
-export type CLXFormQuestionResponseOptions = {
-    field: CLXTextFormField | CLXNumberFormField | CLXTextAreaFormField | CLXBooleanFormField | CLXSelectFormField | CLXMultiSelectFormField | CLXMultipleTextFormField;
-    has_parent?: boolean;
-};
-export type CLXFormQuestion = {
-    slug: string;
-    question_text: string;
-    help_text?: string;
-    response_options: CLXFormQuestionResponseOptions;
-};
-export type CLXFormQuestions = {
-    [questionSlug: string]: CLXFormQuestion;
-};
-export type CLXRuleComparison = 'stringEquals' | 'stringInList' | 'stringListContains' | 'booleanEquals' | 'numberEquals' | 'numberGreaterThan' | 'numberLessThan';
-export type CLXFormRuleDefinition = {
-    subject: string;
-    predicate: CLXFormResponseValue;
-    comparison: CLXRuleComparison;
-};
-export type CLXConditionalOverride = {
-    rule: CLXFormRuleDefinition;
-    override: any;
-};
-export type CLXFormRuleInstanceBase = {
-    subject: CLXFormResponseValue;
-    predicate: CLXFormResponseValue;
-    comparisonType: CLXRuleComparison;
-};
-export type CLXFormRuleStringEqualsInstance = CLXFormRuleInstanceBase & {
-    subject: CLXFormResponseStringValue;
-    predicate: CLXFormResponseStringValue;
-    comparisonType: 'stringEquals';
-};
-export type CLXFormRuleStringInListInstance = CLXFormRuleInstanceBase & {
-    subject: CLXFormResponseStringValue;
-    predicate: CLXFormResponseStringArrayValue;
-    comparisonType: 'stringInList';
-};
-export type CLXFormRuleStringListContainsInstance = CLXFormRuleInstanceBase & {
-    subject: CLXFormResponseStringArrayValue;
-    predicate: CLXFormResponseStringValue;
-    comparisonType: 'stringListContains';
-};
-export type CLXFormRuleBooleanEqualsInstance = CLXFormRuleInstanceBase & {
-    subject: CLXFormResponseBooleanValue;
-    predicate: CLXFormResponseBooleanValue;
-    comparisonType: 'booleanEquals';
-};
-export type CLXFormRuleNumberComparisonInstance = CLXFormRuleInstanceBase & {
-    subject: CLXFormResponseNumberValue;
-    predicate: CLXFormResponseNumberValue;
-    comparisonType: 'numberEquals' | 'numberGreaterThan' | 'numberLessThan';
-};
-export type CLXFormRuleInstance = CLXFormRuleStringEqualsInstance | CLXFormRuleStringInListInstance | CLXFormRuleStringListContainsInstance | CLXFormRuleBooleanEqualsInstance | CLXFormRuleNumberComparisonInstance;
-export type CLXFormQuestionLayout = {
-    id: number;
-    form_question_slug: string;
-    is_required: boolean;
-    is_enabled: boolean;
-    conditions: {
-        max_select_override?: CLXConditionalOverride[];
-        rules: CLXFormRuleDefinition[];
-        combinator: 'and' | 'or';
-    };
-    is_complete?: boolean;
-};
-export type CLXFormSection = {
-    id: number;
-    name: string;
-    question_layouts: CLXFormQuestionLayout[];
-    has_alert?: boolean;
-};
-export type CLXFormQuestionBundle = {
-    question: CLXFormQuestion;
-    layout: CLXFormQuestionLayout;
-};
-export type CLXFormStep = {
-    id: number;
-    name: string;
-    description: string;
-    sections: CLXFormSection[];
-};
-export type CLXFormLayout = {
-    form: {
-        slug: string;
-        name: string;
-        description?: string;
-    };
-    steps: CLXFormStep[];
-    completedCount?: number;
-    totalCount?: number;
-    updated_at?: number;
-};

package/dist/clxforms/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/index.d.ts

@@ -1,62 +0,0 @@
-type ConditionalEnterpriseEventLog<T = {}> = T extends {
-    event_item_id: any;
-} ? {
-    application_source: string;
-    event_item_type: string;
-} : T extends {
-    event_item_type: any;
-} ? {
-    application_source: string;
-} : {};
-export type EnterpriseEventLog = {
-    user_email: string;
-    description: string;
-    application_source?: string;
-    event_action: string;
-    event_unix_time_ms: number;
-    master_id?: number;
-    event_item_id?: string;
-    event_item_type?: string;
-    event_item_name?: string;
-} & ConditionalEnterpriseEventLog;
-type BaseEnterpriseEventLogQuery = {
-    master_id?: string;
-    user_email?: string;
-    limit?: string;
-    offset?: string;
-    order?: 'ASC' | 'DESC';
-};
-export type EnterpriseEventItemIdExists = BaseEnterpriseEventLogQuery & {
-    event_item_id: string;
-    application_source: string;
-    event_item_type: string;
-};
-export type EnterpriseEventItemTypeIdExists = BaseEnterpriseEventLogQuery & {
-    event_item_id?: string;
-    application_source: string;
-    event_item_type: string;
-};
-export type EnterpriseEventNoSpecialRequirements = BaseEnterpriseEventLogQuery & {
-    event_item_id?: never;
-    event_item_type?: never;
-    application_source?: string;
-};
-export type EnterpriseEventLogQuery = EnterpriseEventItemIdExists | EnterpriseEventItemTypeIdExists | EnterpriseEventNoSpecialRequirements;
-export type ServiceKeys = 'accessToken' | 'jwtConfig';
-export type AccessConfigs = {
-    accessToken?: string;
-    jwtConfig?: {
-        jwtEmail: string;
-        jwtSecret: string;
-    };
-};
-export type AccessConfig = {
-    [K in ServiceKeys]: {
-        [P in K]: AccessConfigs[K];
-    };
-}[ServiceKeys];
-export interface XperienceCoreClientConfig {
-    server: string;
-    accessConfig: AccessConfig;
-}
-export {};

package/dist/core/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/credstore/index.d.ts

@@ -1,99 +0,0 @@
-export type CredStoreConfig = {
-    api_server: string;
-    api_key?: string;
-};
-export declare enum CredentialProvider {
-    generic = "generic",
-    entrata = "entrata",
-    realpage = "realpage",
-    yardi = "yardi",
-    mailjet = "mailjet",
-    reba = "reba",
-    rentcafe_v2 = "rentcafe_v2",
-    welcome_home = "welcome_home"
-}
-export type RebaCredStoreBundle = CredStoreBundle & {
-    data: RebaCredential;
-};
-export type EntrataCredStoreBundle = CredStoreBundle & {
-    data: EntrataCredential;
-};
-export type YardiCredStoreBundle = CredStoreBundle & {
-    data: YardiCredential;
-};
-export type RealPageCredStoreBundle = CredStoreBundle & {
-    data: RealPageCredential;
-};
-export type MailJetCredStoreBundle = CredStoreBundle & {
-    data: MailJetCredential;
-};
-export type RentCafeV2CredStoreBundle = CredStoreBundle & {
-    data: RentCafeV2Credential;
-};
-export type WelcomeHomeCredStoreBundle = CredStoreBundle & {
-    data: WelcomeHomeCredential;
-};
-export type LinkedCompany = {
-    master_id: number;
-    name: string;
-};
-export type CredStoreBundle = {
-    id: number;
-    description?: string;
-    guid: string;
-    secret?: string;
-    linkedCompanies?: LinkedCompany[];
-    provider: CredentialProvider;
-    data: GenericCredential | EntrataCredential | RealPageCredential | YardiCredential | RentCafeV2Credential | MailJetCredential | RebaCredential | WelcomeHomeCredential;
-    updated_at: string;
-    created_at: string;
-};
-export type CredentialAttribute = {
-    [x: string]: any;
-};
-export type BaseCredential = {
-    attributes?: Array<CredentialAttribute>;
-};
-export type RebaCredential = BaseCredential & {
-    [x: string]: any;
-};
-export type GenericCredential = BaseCredential & {
-    [x: string]: any;
-};
-export type MailJetCredential = BaseCredential & {
-    username: string;
-    password: string;
-};
-export type EntrataCredential = BaseCredential & {
-    domain: string;
-    username: string;
-    password: string;
-    property_id: string;
-};
-export type RealPageCredential = BaseCredential & {
-    pmcid: string;
-    siteid: string;
-    username: string;
-    password: string;
-    licenseKey: string;
-};
-export type RentCafeV2Credential = BaseCredential & {
-    company_api_key: string;
-    company_code: string;
-};
-export type YardiCredential = BaseCredential & {
-    endpoint: string;
-    userName: string;
-    password: string;
-    serverName: string;
-    database: string;
-    platform: string;
-    yardiPropertyId: string;
-    interfaceEntity: string;
-    interfaceLicense: string;
-};
-export type WelcomeHomeCredential = BaseCredential & {
-    api_key: string;
-    community_id: string;
-    lead_source_id: string;
-};

package/dist/credstore/index.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CredentialProvider = void 0;
-var CredentialProvider;
-(function (CredentialProvider) {
-    CredentialProvider["generic"] = "generic";
-    CredentialProvider["entrata"] = "entrata";
-    CredentialProvider["realpage"] = "realpage";
-    CredentialProvider["yardi"] = "yardi";
-    CredentialProvider["mailjet"] = "mailjet";
-    CredentialProvider["reba"] = "reba";
-    CredentialProvider["rentcafe_v2"] = "rentcafe_v2";
-    CredentialProvider["welcome_home"] = "welcome_home";
-})(CredentialProvider || (exports.CredentialProvider = CredentialProvider = {}));
-;

package/dist/emailhub/index.d.ts

@@ -1,65 +0,0 @@
-export declare enum EmailHubPriorityLevel {
-    NORMAL = "normal",
-    BULK = "bulk"
-}
-export declare enum EmailHubEnvironment {
-    emailhub = "emailhub",
-    localhost = "localhost"
-}
-export interface EmailHubAttachment {
-    ContentType: string;
-    Filename: string;
-    Base64Content: string;
-}
-export interface EmailHubInlineAttachment extends EmailHubAttachment {
-    ContentID: string;
-}
-export interface EmailHubRecipient {
-    Email: string;
-    Name?: string;
-}
-export interface EmailHubMessage {
-    From: {
-        Email: string;
-        Name: string;
-    };
-    To: EmailHubRecipient[];
-    Cc?: EmailHubRecipient[];
-    Bcc?: EmailHubRecipient[];
-    ReplyTo?: EmailHubRecipient | undefined;
-    Subject: string;
-    TextPart?: string;
-    HTMLPart?: string;
-    CustomID?: string;
-    Attachments?: EmailHubAttachment[];
-    InlinedAttachments?: EmailHubInlineAttachment[];
-}
-export interface EmailHubSender {
-    guid: string;
-    secret: string;
-}
-export interface EmailHubConfig {
-    sender: EmailHubSender;
-    server?: string;
-}
-export interface CredentialBody {
-    client_email?: string;
-    private_key?: string;
-}
-export interface EmailHubSenderProfile {
-    id: number;
-    guid: string;
-    domain_name: string;
-    domain_id: string;
-    mailjet_sender_id: string;
-    dkim_txt_name: string;
-    dkim_txt_value: string;
-    dkim_status: string;
-    token_txt_name: string;
-    token_txt_value: string;
-    spf_txt_value: string;
-    spf_status: string;
-    created_at: string;
-    updated_at?: string;
-    verified_at?: string;
-}

package/dist/emailhub/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailHubEnvironment = exports.EmailHubPriorityLevel = void 0;
-var EmailHubPriorityLevel;
-(function (EmailHubPriorityLevel) {
-    EmailHubPriorityLevel["NORMAL"] = "normal";
-    EmailHubPriorityLevel["BULK"] = "bulk";
-})(EmailHubPriorityLevel || (exports.EmailHubPriorityLevel = EmailHubPriorityLevel = {}));
-var EmailHubEnvironment;
-(function (EmailHubEnvironment) {
-    EmailHubEnvironment["emailhub"] = "emailhub";
-    EmailHubEnvironment["localhost"] = "localhost";
-})(EmailHubEnvironment || (exports.EmailHubEnvironment = EmailHubEnvironment = {}));

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-export * as credstore from './credstore';
-export * as clxforms from './clxforms';
-export * as mediahub from './mediahub';
-export * as emailhub from './emailhub';
-export * as core from './core';

package/dist/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.core = exports.emailhub = exports.mediahub = exports.clxforms = exports.credstore = void 0;
-exports.credstore = require("./credstore");
-exports.clxforms = require("./clxforms");
-exports.mediahub = require("./mediahub");
-exports.emailhub = require("./emailhub");
-exports.core = require("./core");

package/dist/mediahub/index.d.ts

@@ -1,98 +0,0 @@
-export interface MediaHubConfig {
-    origin: string;
-    server: string;
-    key: string;
-}
-export interface MediaHubPutAsset {
-    guid: string;
-    url: string;
-    signedPutUrl: string;
-}
-export interface MediaHubAssetTag {
-    id: number;
-    name: string;
-    confidence?: number;
-}
-export interface MediaHubAssetLabel {
-    id: number;
-    name: string;
-}
-export interface MediaHubAssetVersion {
-    id: number;
-    asset_id: number;
-    url: string;
-    cdn_url?: string;
-    cdn_thumbnail_url?: string;
-    file_type?: string;
-    filename?: string;
-    img_width?: number;
-    img_height?: number;
-    created_at: Date;
-    labels?: MediaHubAssetLabel[];
-}
-export interface MediaHubAsset {
-    guid: string;
-    url: string;
-    cdn_thumbnail_url: string;
-    master_id: number;
-    origin_slug: string;
-    filename: string;
-    description: string | null;
-    mime_type: string;
-    tags: MediaHubAssetTag[];
-    versions: MediaHubAssetVersion[];
-    img_width: number | null;
-    img_height: number | null;
-    created_at: Date;
-    uploaded_at: Date | null;
-    updated_at: Date | null;
-    ai_tagged_at: Date | null;
-    archived_at: Date | null;
-    deleted_at: Date | null;
-}
-export interface MediaHubDimensions {
-    width?: number;
-    height?: number;
-}
-export interface MediaHubAssetFilters {
-    master_id: number;
-    guid?: string;
-    filename?: string;
-    description?: string;
-    tag?: MediaHubAssetTag;
-    mime_type?: string;
-    uploaded_before?: Date;
-    uploaded_after?: Date;
-    dimensions_min?: MediaHubDimensions;
-    dimensions_max?: MediaHubDimensions;
-    origin?: string;
-    include_archived?: boolean;
-}
-export type AssetOverlayPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-export type AssetOverlaySize = 'small' | 'medium' | 'large';
-export interface AssetOverlayConfig {
-    position: AssetOverlayPosition;
-    size: AssetOverlaySize;
-}
-export interface AssetOverlay {
-    sourceUrl: string;
-    label: string;
-}
-export interface AssetCrop {
-    width: number;
-    height: number;
-}
-export interface AssetTemplate {
-    id: string;
-    name: string;
-    crop?: AssetCrop;
-    overlays?: AssetOverlay[];
-    overlayConfig?: AssetOverlayConfig;
-    minImageDimensions?: {
-        width?: number;
-        height?: number;
-    };
-}
-export interface AssetMagicSettings {
-    templates?: AssetTemplate[];
-}

package/dist/mediahub/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });