ts2workflows 0.13.0 → 0.15.0

package/types/workflowslib.d.ts

@@ -32,23 +32,43 @@ type HTTPQuery = Record<
   string | number | boolean | (string | number | boolean)[]
 >
 
+type RetryPolicy = {
+  predicate?: (errormap: Record<string, any>) => boolean
+  max_retries?: number | string | null
+  backoff: {
+    initial_delay?: number | string | null
+    max_delay?: number | string | null
+    multiplier?: number | string | null
+  }
+}
+
 // GCP Workflows expression helpers
 
 export declare function double(x: string | number): number
 export declare function int(x: string | number): number
 export declare function string(x: string | number | boolean): string
-export declare function keys(map: Record<string, unknown>): string[]
+export declare function keys<T extends object>(map: T): (keyof T)[]
 export declare function len(
   value: unknown[] | Record<string, unknown> | string,
 ): number
-export declare function get_type(value: unknown): string
+export declare function get_type(
+  value: unknown,
+):
+  | 'boolean'
+  | 'bytes'
+  | 'double'
+  | 'integer'
+  | 'list'
+  | 'map'
+  | 'string'
+  | 'null'
 
 // GCP Workflows standard library functions
 // https://cloud.google.com/workflows/docs/reference/stdlib/overview
 
 export declare namespace base64 {
-  function decode(data: bytes, padding?: boolean): string
-  function encode(data: string, padding?: boolean): bytes
+  function decode(data: string, padding?: boolean): bytes
+  function encode(data: bytes, padding?: boolean): string
 }
 
 export declare namespace events {
@@ -68,7 +88,7 @@ export declare namespace events {
     received_time: string
     type: string
   }
-  function create_callback_endpoint(http_callback_method: string): {
+  function create_callback_endpoint(http_callback_method?: string): {
     url: string
   }
 }
@@ -83,10 +103,8 @@ export declare namespace hash {
 }
 
 export declare namespace http {
-  export function default_retry(errormap: Record<string, any>): void
-  export function default_retry_non_idempotent(
-    errormap: Record<string, any>,
-  ): void
+  export const default_retry: RetryPolicy
+  export const default_retry_non_idempotent: RetryPolicy
   export function default_retry_predicate(
     errormap: Record<string, any>,
   ): boolean
@@ -309,9 +327,9 @@ export declare namespace uuid {
 
 // Connectors
 
-// Cloud Firestore API Connector
-// https://cloud.google.com/workflows/docs/reference/googleapis/firestore/Overview
 export declare namespace googleapis {
+  // Cloud Firestore API Connector
+  // https://cloud.google.com/workflows/docs/reference/googleapis/firestore/Overview
   namespace firestore {
     namespace v1 {
       interface ArrayValue {
@@ -528,9 +546,9 @@ export declare namespace googleapis {
         transaction?: string
       }
       interface RunQueryResponse {
-        document: Document
+        document?: Document
         readTime: string
-        skippedResults: number
+        skippedResults?: number
         transaction?: string
       }
       interface Status {
@@ -679,8 +697,8 @@ export declare namespace googleapis {
             ): PartitionQueryResponse
             export function patch(
               name: string,
-              currentDocument: Precondition,
-              mask: DocumentMask,
+              currentDocument: Precondition | undefined,
+              mask: DocumentMask | undefined,
               updateMask: DocumentMask,
               body: Pick<Document, 'fields' | 'name'>,
             ): Document
@@ -691,7 +709,7 @@ export declare namespace googleapis {
             export function runQuery(
               parent: string,
               body: RunQueryRequest,
-            ): RunQueryResponse
+            ): RunQueryResponse[]
             export { _delete as delete }
           }
           namespace operations {
@@ -719,6 +737,340 @@ export declare namespace googleapis {
       }
     }
   }
+
+  // Cloud Pub/Sub API Connector
+  // https://docs.cloud.google.com/workflows/docs/reference/googleapis/pubsub/Overview
+  namespace pubsub {
+    namespace v1 {
+      interface AcknowledgeRequest {
+        ackIds: string[]
+      }
+      interface Binding {
+        condition: Expr
+        members: string[]
+        role: string
+      }
+      interface CreateSnapshotRequest {
+        label?: Record<string, string>
+        subscription: string
+      }
+      interface DeadLetterPolicy {
+        deadLetterTopic: string
+        maxDeliveryAttempts?: number
+      }
+      interface Expr {
+        description?: string
+        expression: string
+        location?: string
+        title?: string
+      }
+      interface ExpirationPolicy {
+        ttl: string
+      }
+      interface ListSchemasResponse {
+        nextPageToken?: string
+        schemas: Schema[]
+      }
+      interface ListSnapshotsResponse {
+        nextPagetoken?: string
+        snapshots?: Snapshot[]
+      }
+      interface ListSubscriptionsResponse {
+        nextPageToken?: string
+        subscriptions?: Subscription[]
+      }
+      interface ListTopicsResponse {
+        nextPageToken?: string
+        topics?: Topic[]
+      }
+      interface ListTopicSubscriptionsResponse {
+        nextPageToken?: string
+        subscriptions?: string[]
+      }
+      interface ListTopicSnapshotsResponse {
+        nextPageToken?: string
+        snapshots?: string[]
+      }
+      interface MessageStoragePolicy {
+        allowedPersistenceRegions?: string[]
+      }
+      interface ModifyAckDeadlineRequest {
+        ackDeadlineSeconds: number
+        ackIds: string[]
+      }
+      interface ModifyPushConfigRequest {
+        pushConfig: PushConfig
+      }
+      interface OidcToken {
+        audience: string
+        serviceAccountEmail: string
+      }
+      interface Policy {
+        bindings: Binding[]
+        etag: string
+        version: number
+      }
+      interface PublishRequest {
+        messages: PubsubMessage[]
+      }
+      interface PublishResponse {
+        messageIds?: string[]
+      }
+      interface PubsubMessage {
+        attributes?: Record<string, string>
+        data?: string
+        messageId?: string
+        orderingKey?: string
+        publishTime?: string
+      }
+      interface PullRequest {
+        maxMessages: number
+        returnImmediately?: boolean
+      }
+      interface PullResponse {
+        receivedMessages: ReceivedMessage[]
+      }
+      interface PushConfig {
+        attributes: Record<string, string>
+        oidcToken: OidcToken
+        pushEndpoint: string
+      }
+      interface ReceivedMessage {
+        ackId: string
+        deliveryAttempt: number
+        message: PubsubMessage
+      }
+      interface RetryPolicy {
+        maximumBackoff?: string
+        minimumBackoff?: string
+      }
+      interface Schema {
+        definition: string
+        name: string
+        type: 'TYPE_UNSPECIFIED' | 'PROTOCOL_BUFFER' | 'AVRO'
+      }
+      interface SchemaSettings {
+        encoding?: 'ENCODING_UNSPECIFIED' | 'JSON' | 'BINARY'
+        schema: string
+      }
+      interface SeekRequest {
+        snapshot?: string
+        time?: string
+      }
+      interface SetIamPolicyRequest {
+        policy: Policy
+      }
+      interface Snapshot {
+        expireTime?: string
+        labels?: Record<string, string>
+        name?: string
+        topic?: string
+      }
+      interface Subscription {
+        ackDeadlineSeconds?: number
+        deadLetterPolicy?: DeadLetterPolicy
+        detached?: boolean
+        enableMessageOrdering?: boolean
+        expirationPolicy?: ExpirationPolicy
+        filter?: string
+        labels?: Record<string, string>
+        messageRetentionDuration?: string
+        name: string
+        pushConfig?: PushConfig
+        retainAckedMessages?: boolean
+        retryPolicy?: RetryPolicy
+        topic: string
+        topicMessageRetentionDuration?: string
+      }
+      interface TestIamPermissionsRequest {
+        permissions: string[]
+      }
+      interface TestIamPermissionsResponse {
+        permissions: string[]
+      }
+      interface Topic {
+        kmsKeyName?: string
+        labels?: Map<string, string>
+        messageRetentionDuration?: string
+        messageStoragePolicy?: MessageStoragePolicy
+        name: string
+        satisfiesPzs?: boolean
+        schemaSettings?: SchemaSettings
+      }
+      interface UpdateSnapshotRequest {
+        snapshot: Snapshot
+        updateMask: string
+      }
+      interface UpdateSubscriptionRequest {
+        subscription: Subscription
+        updateMask: string
+      }
+      interface UpdateTopicRequest {
+        topic: Topic
+        updateMask: string
+      }
+      interface ValidateMessageRequest {
+        encoding: 'ENCODING_UNSPECIFIED' | 'JSON' | 'BINARY'
+        message: string
+        name?: string
+        schema?: Schema
+      }
+      interface ValidateSchemaRequest {
+        object: Schema
+      }
+
+      namespace projects {
+        namespace schemas {
+          export function create(
+            parent: string,
+            schemaId: string,
+            body: Schema,
+          ): Schema
+          function _delete(name: string): void
+          export { _delete as delete }
+          export function get(
+            name: string,
+            view?: 'SCHEMA_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL',
+          ): Schema
+          export function list(
+            parent: string,
+            pageSize?: number,
+            pageToken?: string,
+            view?: 'SCHEMA_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL',
+          ): ListSchemasResponse
+          export function validate(
+            parent: string,
+            body: ValidateSchemaRequest,
+          ): void
+          export function validateMessage(
+            parent: string,
+            body: ValidateMessageRequest,
+          ): void
+        }
+
+        namespace snapshots {
+          export function create(
+            name: string,
+            object: CreateSnapshotRequest,
+          ): Snapshot
+          function _delete(snapshot: string): void
+          export { _delete as delete }
+          export function getIamPolicy(
+            resource: string,
+            options: { requestedPolicyVersion: number },
+          ): Policy
+          export function list(
+            project: string,
+            pageSize?: number,
+            pageToken?: string,
+          ): ListSnapshotsResponse
+          export function patch(
+            name: string,
+            body: UpdateSnapshotRequest,
+          ): Snapshot
+          export function setIamPolicy(
+            resource: string,
+            body: SetIamPolicyRequest,
+          ): Policy
+          export function testIamPermissions(
+            resource: string,
+            body: TestIamPermissionsRequest,
+          ): TestIamPermissionsResponse
+        }
+
+        namespace subscriptions {
+          export function acknowledge(
+            subscription: string,
+            body: AcknowledgeRequest,
+          ): void
+          export function create(name: string, body: Subscription): Subscription
+          function _delete(subscription: string): void
+          export { _delete as delete }
+          export function detach(subscription: string): void
+          export function get(subscription: string): Subscription
+          export function getIamPolicy(
+            resource: string,
+            options: { requestedPolicyVersion: number },
+          ): Policy
+          export function list(
+            project: string,
+            pageSize?: number,
+            pageToken?: string,
+          ): ListSubscriptionsResponse
+          export function modifyAckDeadline(
+            subscription: string,
+            body: ModifyAckDeadlineRequest,
+          ): void
+          export function modifyPushConfig(
+            subscription: string,
+            body: ModifyPushConfigRequest,
+          ): void
+          export function patch(
+            name: string,
+            body: UpdateSubscriptionRequest,
+          ): Subscription
+          export function pull(
+            subscription: string,
+            body: PullRequest,
+          ): PullResponse
+          export function seek(subscription: string, body: SeekRequest): void
+          export function setIamPolicy(
+            resource: string,
+            body: SetIamPolicyRequest,
+          ): Policy
+          export function testIamPermissions(
+            resource: string,
+            body: TestIamPermissionsRequest,
+          ): TestIamPermissionsResponse
+        }
+
+        namespace topics {
+          export function create(name: string, body: Topic): Topic
+          function _delete(topic: string): void
+          export { _delete as delete }
+          export function get(topic: string): Topic
+          export function getIamPolicy(
+            resource: string,
+            options: { requestedPolicyVersion: number },
+          ): Policy
+          export function list(
+            project: string,
+            pageSize?: number,
+            pageToken?: string,
+          ): ListTopicsResponse
+          export function patch(name: string, body: UpdateTopicRequest): Topic
+          export function publish(
+            topic: string,
+            body: PublishRequest,
+          ): PublishResponse
+          export function setIamPolicy(
+            resource: string,
+            body: SetIamPolicyRequest,
+          ): Policy
+          export function testIamPermissions(
+            resource: string,
+            body: TestIamPermissionsRequest,
+          ): TestIamPermissionsResponse
+
+          namespace snapshots {
+            export function list(
+              topic: string,
+              pageSize?: number,
+              pageToken?: string,
+            ): ListTopicSnapshotsResponse
+          }
+
+          namespace subscriptions {
+            export function list(
+              topic: string,
+              pageSize?: number,
+              pageToken?: string,
+            ): ListTopicSubscriptionsResponse
+          }
+        }
+      }
+    }
+  }
 }
 
 // Functionality that is not implemented by Typescript keywords
@@ -732,19 +1084,7 @@ export declare function parallel(
   },
 ): void
 
-export declare function retry_policy(
-  params:
-    | ((errormap: Record<string, any>) => void)
-    | {
-        predicate?: (errormap: Record<string, any>) => boolean
-        max_retries?: number | string | null
-        backoff: {
-          initial_delay?: number | string | null
-          max_delay?: number | string | null
-          multiplier?: number | string | null
-        }
-      },
-): void
+export declare function retry_policy(params: RetryPolicy): void
 
 export declare function call_step<T, A extends any[]>(
   func: (...args: A) => T,