@shushed/helpers 0.0.20 → 0.0.22

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 import { JSONSchemaType } from 'ajv';
 import { DeepRedact } from '@hackylabs/deep-redact';
+import { DocumentReference, Firestore } from '@google-cloud/firestore';
+import { PubSub, Topic, Subscription } from '@google-cloud/pubsub';
+import * as _google_cloud_scheduler_build_protos_protos from '@google-cloud/scheduler/build/protos/protos';
+import { CloudSchedulerClient } from '@google-cloud/scheduler';
+import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
 
 declare const schema$l: {
     readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -118,6 +123,7 @@ declare const schema$i: {
         readonly attributes: {
             readonly type: "object";
             readonly additionalProperties: false;
+            readonly required: readonly ["product_type", "product_category", "product_subcategory", "division", "care_instructions", "range", "main_fibre", "size_range", "sizes", "occasion", "strategy_type", "pattern_name", "neckline", "sleeve_length", "leg_length", "heel_height", "heel_shape", "toe_shape", "handle_straps", "fastening", "sole_code", "fashionability", "weight", "average_weight_grams", "length_measurement", "fabric_composition_footwear"];
             readonly properties: {
                 readonly product_type: {
                     readonly type: "string";
@@ -216,6 +222,7 @@ declare const schema$i: {
         readonly cost: {
             readonly type: "object";
             readonly additionalProperties: false;
+            readonly required: readonly ["retail_price", "current_cost", "moq", "finishing_cost", "other_costs", "freight_rate", "duty_rate", "commodity_code_ref"];
             readonly properties: {
                 readonly retail_price: {
                     readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -515,6 +522,7 @@ declare const schema$i: {
         readonly supplier_data: {
             readonly type: "object";
             readonly additionalProperties: false;
+            readonly required: readonly ["country_of_origin", "port_of_origin", "supplier_id", "factory_id"];
             readonly properties: {
                 readonly country_of_origin: {
                     readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -554,7 +562,7 @@ declare const schema$i: {
             };
         };
     };
-    readonly required: readonly ["product_name", "colour_label", "developement_colourway_id", "colour_id", "style_id", "season_id", "drop_name", "stock_type", "block", "packing_method", "is_bought_in_product", "is_carry_over", "image_url", "product_type", "product_category", "division", "care_instructions", "range", "main_fibre", "size_range", "sizes", "occasion", "strategy_type", "pattern_name", "neckline", "sleeve_length", "leg_length", "heel_height", "heel_shape", "toe_shape", "handle_straps", "fastening", "sole_code", "fashionability", "weight", "average_weight_grams", "length_measurement", "fabric_composition_footwear", "retail_price", "current_cost", "currency", "moq", "finishing_cost", "other_costs", "freight_rate", "duty_rate", "commodity_code_ref", "country_of_origin", "port_of_origin", "supplier_id", "factory_id"];
+    readonly required: readonly ["product_name", "colour_label", "developement_colourway_id", "colour_id", "style_id", "season_name", "drop_name", "stock_type", "block", "packing_method", "is_bought_in_product", "is_carry_over", "image_url", "attributes", "cost", "supplier_data"];
     readonly $id: "https://shushed.example.com/product-draft.schema.json";
 };
 
@@ -812,6 +820,7 @@ declare const schema$f: {
             readonly attributes: {
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly required: readonly ["product_type", "product_category", "product_subcategory", "division", "care_instructions", "range", "main_fibre", "size_range", "sizes", "occasion", "strategy_type", "pattern_name", "neckline", "sleeve_length", "leg_length", "heel_height", "heel_shape", "toe_shape", "handle_straps", "fastening", "sole_code", "fashionability", "weight", "average_weight_grams", "length_measurement", "fabric_composition_footwear"];
                 readonly properties: {
                     readonly product_type: {
                         readonly type: "string";
@@ -910,6 +919,7 @@ declare const schema$f: {
             readonly cost: {
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly required: readonly ["retail_price", "current_cost", "moq", "finishing_cost", "other_costs", "freight_rate", "duty_rate", "commodity_code_ref"];
                 readonly properties: {
                     readonly retail_price: {
                         readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -1209,6 +1219,7 @@ declare const schema$f: {
             readonly supplier_data: {
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly required: readonly ["country_of_origin", "port_of_origin", "supplier_id", "factory_id"];
                 readonly properties: {
                     readonly country_of_origin: {
                         readonly $schema: "http://json-schema.org/draft-07/schema#";
@@ -1248,7 +1259,7 @@ declare const schema$f: {
                 };
             };
         };
-        readonly required: readonly ["product_name", "colour_label", "developement_colourway_id", "colour_id", "style_id", "season_id", "drop_name", "stock_type", "block", "packing_method", "is_bought_in_product", "is_carry_over", "image_url", "product_type", "product_category", "division", "care_instructions", "range", "main_fibre", "size_range", "sizes", "occasion", "strategy_type", "pattern_name", "neckline", "sleeve_length", "leg_length", "heel_height", "heel_shape", "toe_shape", "handle_straps", "fastening", "sole_code", "fashionability", "weight", "average_weight_grams", "length_measurement", "fabric_composition_footwear", "retail_price", "current_cost", "currency", "moq", "finishing_cost", "other_costs", "freight_rate", "duty_rate", "commodity_code_ref", "country_of_origin", "port_of_origin", "supplier_id", "factory_id"];
+        readonly required: readonly ["product_name", "colour_label", "developement_colourway_id", "colour_id", "style_id", "season_name", "drop_name", "stock_type", "block", "packing_method", "is_bought_in_product", "is_carry_over", "image_url", "attributes", "cost", "supplier_data"];
     }, {
         readonly type: "object";
         readonly additionalProperties: false;
@@ -26582,7 +26593,7 @@ interface __MainSchema$n {
     developement_colourway_id: string;
     colour_id: string;
     style_id: string;
-    season_name?: string;
+    season_name: string;
     drop_name: ("January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December" | "Carryover");
     development_style_id?: string;
     stock_type: string;
@@ -26592,58 +26603,58 @@ interface __MainSchema$n {
     reprocess_method?: (string | null);
     is_carry_over: boolean;
     image_url: string;
-    attributes?: {
-        product_type?: string;
-        product_category?: string;
-        product_subcategory?: string;
-        division?: ("Women" | null);
-        care_instructions?: string;
-        range?: (("Main Collection" | "Seasonal") | null);
-        main_fibre?: string;
-        size_range?: string;
-        sizes?: string;
-        occasion?: string;
-        strategy_type?: string;
-        pattern_name?: string;
-        neckline?: string;
-        sleeve_length?: (string | null);
-        leg_length?: (string | null);
-        heel_height?: (string | null);
-        heel_shape?: string;
-        toe_shape?: string;
-        handle_straps?: string;
-        fastening?: string;
-        sole_code?: string;
-        fashionability?: ("Core" | null);
+    attributes: {
+        product_type: string;
+        product_category: string;
+        product_subcategory: string;
+        division: ("Women" | null);
+        care_instructions: string;
+        range: (("Main Collection" | "Seasonal") | null);
+        main_fibre: string;
+        size_range: string;
+        sizes: string;
+        occasion: string;
+        strategy_type: string;
+        pattern_name: string;
+        neckline: string;
+        sleeve_length: (string | null);
+        leg_length: (string | null);
+        heel_height: (string | null);
+        heel_shape: string;
+        toe_shape: string;
+        handle_straps: string;
+        fastening: string;
+        sole_code: string;
+        fashionability: ("Core" | null);
         fashion_type?: string;
         development_type?: string;
-        weight?: (string | null);
-        average_weight_grams?: number;
+        weight: (string | null);
+        average_weight_grams: number;
         extra_selling_point?: string;
-        length_measurement?: (string | null);
-        fabric_composition_footwear?: string;
+        length_measurement: (string | null);
+        fabric_composition_footwear: string;
     };
-    cost?: {
-        retail_price?: Money$a;
-        current_cost?: Money$a;
-        moq?: number;
-        finishing_cost?: Money$a;
-        other_costs?: Money$a;
+    cost: {
+        retail_price: Money$a;
+        current_cost: Money$a;
+        moq: number;
+        finishing_cost: Money$a;
+        other_costs: Money$a;
         commission?: Money$a;
-        freight_rate?: Money$a;
-        duty_rate?: Money$a;
-        commodity_code_ref?: string;
+        freight_rate: Money$a;
+        duty_rate: Money$a;
+        commodity_code_ref: string;
     };
     payment_terms?: {
         supplier_payment_terms?: (string | null);
         supplier_inco_terms?: string;
     };
-    supplier_data?: {
-        country_of_origin?: Country$9;
-        port_of_origin?: string;
-        supplier_id?: string;
+    supplier_data: {
+        country_of_origin: Country$9;
+        port_of_origin: string;
+        supplier_id: string;
         supplier_name?: string;
-        factory_id?: string;
+        factory_id: string;
     };
     buying_and_size_curve?: {
         direct?: string;
@@ -26718,7 +26729,7 @@ interface ProductDraft {
     developement_colourway_id: string;
     colour_id: string;
     style_id: string;
-    season_name?: string;
+    season_name: string;
     drop_name: ("January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December" | "Carryover");
     development_style_id?: string;
     stock_type: string;
@@ -26728,58 +26739,58 @@ interface ProductDraft {
     reprocess_method?: (string | null);
     is_carry_over: boolean;
     image_url: string;
-    attributes?: {
-        product_type?: string;
-        product_category?: string;
-        product_subcategory?: string;
-        division?: ("Women" | null);
-        care_instructions?: string;
-        range?: (("Main Collection" | "Seasonal") | null);
-        main_fibre?: string;
-        size_range?: string;
-        sizes?: string;
-        occasion?: string;
-        strategy_type?: string;
-        pattern_name?: string;
-        neckline?: string;
-        sleeve_length?: (string | null);
-        leg_length?: (string | null);
-        heel_height?: (string | null);
-        heel_shape?: string;
-        toe_shape?: string;
-        handle_straps?: string;
-        fastening?: string;
-        sole_code?: string;
-        fashionability?: ("Core" | null);
+    attributes: {
+        product_type: string;
+        product_category: string;
+        product_subcategory: string;
+        division: ("Women" | null);
+        care_instructions: string;
+        range: (("Main Collection" | "Seasonal") | null);
+        main_fibre: string;
+        size_range: string;
+        sizes: string;
+        occasion: string;
+        strategy_type: string;
+        pattern_name: string;
+        neckline: string;
+        sleeve_length: (string | null);
+        leg_length: (string | null);
+        heel_height: (string | null);
+        heel_shape: string;
+        toe_shape: string;
+        handle_straps: string;
+        fastening: string;
+        sole_code: string;
+        fashionability: ("Core" | null);
         fashion_type?: string;
         development_type?: string;
-        weight?: (string | null);
-        average_weight_grams?: number;
+        weight: (string | null);
+        average_weight_grams: number;
         extra_selling_point?: string;
-        length_measurement?: (string | null);
-        fabric_composition_footwear?: string;
+        length_measurement: (string | null);
+        fabric_composition_footwear: string;
     };
-    cost?: {
-        retail_price?: Money$9;
-        current_cost?: Money$9;
-        moq?: number;
-        finishing_cost?: Money$9;
-        other_costs?: Money$9;
+    cost: {
+        retail_price: Money$9;
+        current_cost: Money$9;
+        moq: number;
+        finishing_cost: Money$9;
+        other_costs: Money$9;
         commission?: Money$9;
-        freight_rate?: Money$9;
-        duty_rate?: Money$9;
-        commodity_code_ref?: string;
+        freight_rate: Money$9;
+        duty_rate: Money$9;
+        commodity_code_ref: string;
     };
     payment_terms?: {
         supplier_payment_terms?: (string | null);
         supplier_inco_terms?: string;
     };
-    supplier_data?: {
-        country_of_origin?: Country$8;
-        port_of_origin?: string;
-        supplier_id?: string;
+    supplier_data: {
+        country_of_origin: Country$8;
+        port_of_origin: string;
+        supplier_id: string;
         supplier_name?: string;
-        factory_id?: string;
+        factory_id: string;
     };
     buying_and_size_curve?: {
         direct?: string;
@@ -28685,11 +28696,162 @@ declare function validate<T>(payload: T, schema: JSONSchemaType<T>, options: {
 declare const sanitizeToString: DeepRedact;
 declare const sanitize: DeepRedact;
 
+type Opts = {
+    workflowId: string;
+    triggerId: string;
+    url: string;
+    envName: string;
+} | {
+    workflowId: string;
+    triggerId: string;
+    url: string;
+};
+declare class Runtime {
+    readonly workflowId: string;
+    readonly triggerId: string;
+    readonly envName: string;
+    readonly systemEnvName: string;
+    readonly runtimeUrl: string;
+    constructor(opts: Opts);
+}
+
+declare class EnvEngine extends Runtime {
+    docRef: DocumentReference;
+    private store;
+    constructor(opts: Opts, firestore: Firestore);
+    set(envs: Array<{
+        name: string;
+        value: string;
+    }>): Promise<undefined>;
+    private initializeIfNeeded;
+    get<T extends ReadonlyArray<string>>(keys: T): Promise<{
+        [K in T[number]]: string;
+    }>;
+    get(key: string): Promise<string>;
+}
+
+declare class PubSubHelper extends Runtime {
+    private pubSub;
+    constructor(opts: Opts, pubSub: PubSub);
+    createOrUpdate(opts: {
+        topicName: string;
+        dlq: boolean;
+        retryLimit: number;
+        retryDelay: number;
+        ackDeadline: number;
+    }): Promise<{
+        topic: Topic;
+        dlqTopic: Topic | null;
+        dlqSubscription: Subscription | null;
+        subscription: Subscription;
+    }>;
+    private findTopic;
+    private ensureTopicExists;
+    private getNameFromFullyQualifiedName;
+    private ensureSubscribtionExists;
+    private ensureDLQSubscriptionExists;
+    deleteSubscription(subscriptionURN: string): Promise<any>;
+}
+
+declare class SchedulerHelper extends Runtime {
+    private extraQuery;
+    private pubSubTarget;
+    private pubSubProjectId;
+    private schedulerLocationId;
+    private schedulerClient;
+    constructor(opts: Opts & {
+        extraQuery: Record<string, string>;
+        serviceAccount: string;
+        defaultServiceAccount: string;
+        pubSubTarget?: Topic | null;
+        schedulerLocationId?: string | null;
+    }, schedulerClient: CloudSchedulerClient);
+    get locationIds(): string[];
+    getTarget(): {
+        pubsubTarget: {
+            topicName: string;
+            data: Buffer<ArrayBuffer>;
+        };
+        httpTarget?: undefined;
+    } | {
+        httpTarget: {
+            uri: string;
+            httpMethod: "POST";
+            headers: {
+                "Content-Type": string;
+            };
+            oidcToken: {
+                serviceAccountEmail: string;
+                audience: string;
+            };
+        };
+        pubsubTarget?: undefined;
+    };
+    create({ schedule, timezone }: {
+        schedule: string;
+        timezone: string;
+    }): Promise<{
+        status: _google_cloud_scheduler_build_protos_protos.google.rpc.IStatus | null | undefined;
+        state: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.Job.State | "STATE_UNSPECIFIED" | "ENABLED" | "PAUSED" | "DISABLED" | "UPDATE_FAILED" | null | undefined;
+        name: string | null | undefined;
+        httpTarget: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.IHttpTarget | null | undefined;
+        pubsubTarget: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.IPubsubTarget | null | undefined;
+    }>;
+    update({ schedule, timezone }: {
+        schedule: string;
+        timezone: string;
+    }): Promise<{
+        status: _google_cloud_scheduler_build_protos_protos.google.rpc.IStatus | null | undefined;
+        state: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.Job.State | "STATE_UNSPECIFIED" | "ENABLED" | "PAUSED" | "DISABLED" | "UPDATE_FAILED" | null | undefined;
+        name: string | null | undefined;
+        httpTarget: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.IHttpTarget | null | undefined;
+        pubsubTarget: _google_cloud_scheduler_build_protos_protos.google.cloud.scheduler.v1.IPubsubTarget | null | undefined;
+    }>;
+    delete(): Promise<any>;
+}
+
+declare class Secrets extends Runtime {
+    private secretsManagerClient;
+    constructor(opts: Opts, secretsManagerClient: SecretManagerServiceClient);
+    getSecret(name: string): Promise<string>;
+}
+
+declare class JWKSHelper extends Runtime {
+    private firestore;
+    constructor(opts: Opts, firestore: Firestore);
+    validateAuthorizationHeader(authorizationHeader: string, expectedServiceAccount?: string | null): Promise<boolean>;
+    getKey(keyId: string): Promise<{
+        kid: string;
+    } | undefined>;
+    private fetchJWKS;
+}
+
+declare const isPubSubRequest: (headers: Record<string, string>) => boolean;
+declare const isCronMessage: (headers: Record<string, string>) => boolean;
+declare const validateGoogleAuth: (opts: Opts & {
+    serviceAccount?: string | null;
+}, headers: Record<string, string>, firestore: Firestore) => Promise<void>;
+
+type index_EnvEngine = EnvEngine;
+declare const index_EnvEngine: typeof EnvEngine;
+type index_JWKSHelper = JWKSHelper;
+declare const index_JWKSHelper: typeof JWKSHelper;
+type index_PubSubHelper = PubSubHelper;
+declare const index_PubSubHelper: typeof PubSubHelper;
+type index_Runtime = Runtime;
+declare const index_Runtime: typeof Runtime;
+type index_SchedulerHelper = SchedulerHelper;
+declare const index_SchedulerHelper: typeof SchedulerHelper;
+type index_Secrets = Secrets;
+declare const index_Secrets: typeof Secrets;
+declare const index_isCronMessage: typeof isCronMessage;
+declare const index_isPubSubRequest: typeof isPubSubRequest;
 declare const index_sanitize: typeof sanitize;
 declare const index_sanitizeToString: typeof sanitizeToString;
 declare const index_validate: typeof validate;
+declare const index_validateGoogleAuth: typeof validateGoogleAuth;
 declare namespace index {
-  export { index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_validate as validate };
+  export { index_EnvEngine as EnvEngine, index_JWKSHelper as JWKSHelper, index_PubSubHelper as PubSubHelper, index_Runtime as Runtime, index_SchedulerHelper as SchedulerHelper, index_Secrets as Secrets, index_isCronMessage as isCronMessage, index_isPubSubRequest as isPubSubRequest, index_sanitize as sanitize, index_sanitizeToString as sanitizeToString, index_validate as validate, index_validateGoogleAuth as validateGoogleAuth };
 }
 
 export { index as lib, index$9 as schema, index$1 as types };