@azure-rest/purview-workflow 1.0.0-beta.1 → 1.0.0-beta.3

package/{dist-esm/src → dist/browser}/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** Describes under what condition a workflow will run. */\nexport interface Trigger {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Create or update workflow payload. */\nexport interface WorkflowCreateOrUpdateCommand {\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<Trigger>;\n  /** The workflow name. */\n  name: string;\n  /** Whether the workflow enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag?: Record<string, unknown>;\n}\n\nexport interface UserRequestPayload {\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<Operation>;\n  /** The comment when submit a user request. */\n  comment?: string;\n}\n\n/** The operation user wants to perform. */\nexport interface Operation {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\nexport interface WorkflowRunCancelRequest {\n  /** The comment of canceling a workflow run. */\n  comment?: string;\n}\n\nexport interface ApprovalResponseComment {\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n}\n\n/** The request payload of reassigning a workflow task. */\nexport interface ReassignCommand {\n  /** The request body of reassigning a workflow task. */\n  reassignments?: Array<ReassignCommandReassignmentsItem>;\n}\n\nexport interface ReassignCommandReassignmentsItem {\n  /**\n   * Reassign a workflow task from a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignFrom: string;\n  /**\n   * Reassign a workflow task to a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignTo: string;\n}\n\nexport interface TaskUpdateCommand {\n  /** The new status will be used to update the task. */\n  newStatus: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  /** The comment when update a task. */\n  comment?: string;\n}\n"]}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Describes under what condition a workflow will run. */\nexport interface Trigger {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Create or update workflow payload. */\nexport interface WorkflowCreateOrUpdateCommand {\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<Trigger>;\n  /** The workflow name. */\n  name: string;\n  /** Whether the workflow enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag?: Record<string, unknown>;\n}\n\nexport interface UserRequestPayload {\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<Operation>;\n  /** The comment when submit a user request. */\n  comment?: string;\n}\n\n/** The operation user wants to perform. */\nexport interface Operation {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\nexport interface WorkflowRunCancelRequest {\n  /** The comment of canceling a workflow run. */\n  comment?: string;\n}\n\nexport interface ApprovalResponseComment {\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n}\n\n/** The request payload of reassigning a workflow task. */\nexport interface ReassignCommand {\n  /** The request body of reassigning a workflow task. */\n  reassignments?: Array<ReassignCommandReassignmentsItem>;\n}\n\nexport interface ReassignCommandReassignmentsItem {\n  /**\n   * Reassign a workflow task from a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignFrom: string;\n  /**\n   * Reassign a workflow task to a user or a group.\n   *\n   * Value may contain a UUID\n   */\n  reassignTo: string;\n}\n\nexport interface TaskUpdateCommand {\n  /** The new status will be used to update the task. */\n  newStatus: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  /** The comment when update a task. */\n  comment?: string;\n}\n"]}

package/dist/browser/outputModels.d.ts

@@ -0,0 +1,325 @@
+/** The workflow list. */
+export interface WorkflowMetadataListOutput {
+    /** The value of workflow list. */
+    value: Array<WorkflowMetadataOutput>;
+    /** The URL to get the next set of results. */
+    nextLink?: string;
+}
+/** The workflow metadata, action DAGs are not included. */
+export interface WorkflowMetadataOutput {
+    /**
+     * The id of workflow.
+     *
+     * Value may contain a UUID
+     */
+    id: string;
+    /** It describes under what condition a workflow will run.  */
+    triggers: Array<TriggerOutput>;
+    /** The created time of workflow. */
+    createdTime?: string;
+    /** The person who created the workflow. */
+    createdBy?: string;
+    /** The last update time. */
+    lastUpdateTime?: string;
+    /** The person who updated the workflow. */
+    updatedBy?: string;
+    /** The name of a workflow. */
+    name: string;
+    /** Whether the workflow is enabled or not. */
+    isEnabled: boolean;
+    /** Description of a workflow. */
+    description: string;
+}
+/** Describes under what condition a workflow will run. */
+export interface TriggerOutput {
+    type: "when_term_creation_is_requested" | "when_term_deletion_is_requested" | "when_term_update_is_requested" | "when_terms_import_is_requested" | "when_data_access_grant_is_requested" | "when_asset_update_is_requested";
+    /** Glossary term hierarchy path. */
+    underGlossaryHierarchy?: string;
+    /** The collection name. */
+    underCollection?: string;
+    /** The glossary guid. */
+    underGlossary?: string;
+}
+/** Default error response model */
+export interface ErrorResponseOutput {
+    /** Default error model */
+    error: ErrorModelOutput;
+}
+/** Default error model */
+export interface ErrorModelOutput {
+    /** Gets or sets the code. */
+    code: string;
+    /** Gets or sets the details. */
+    details?: Array<ErrorModelOutput>;
+    /** Gets or sets the messages. */
+    message: string;
+    /** Gets or sets the target. */
+    target?: string;
+}
+/** The workflow properties. It includes the triggers, actual flow and other properties of a workflow. */
+export interface WorkflowOutput extends WorkflowMetadataOutput {
+    /** The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order. */
+    actionDag: Record<string, unknown>;
+}
+/** Describes user ask to do operation(s) on Purview. */
+export interface UserRequestResponseOutput {
+    /**
+     * The user request id.
+     *
+     * Value may contain a UUID
+     */
+    requestId: string;
+    /**
+     * The person who submitted the user request.
+     *
+     * Value may contain a UUID
+     */
+    requestor: string;
+    /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */
+    operations: Array<UserRequestResponseOperationsItemOutput>;
+    /** The comment when submit a user request. */
+    comment?: string;
+    /** The status. */
+    status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
+}
+/** The operation user wants to perform. */
+export interface UserRequestResponseOperationsItemOutput {
+    /** The operation type. */
+    type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
+    /** The payload of each operation which user want to submit. */
+    payload: Record<string, unknown>;
+    workflowRunIds?: Array<string>;
+}
+export interface WorkflowRunListOutput {
+    /** The value of workflow run list. */
+    value: Array<WorkflowRunMetadataOutput>;
+    /** The URL to get the next set of results. */
+    nextLink?: string;
+}
+/** The execution of a workflow. It includes status of the entire run and other properties of a run. */
+export interface WorkflowRunMetadataOutput {
+    /**
+     * The workflow run id.
+     *
+     * Value may contain a UUID
+     */
+    id: string;
+    /**
+     * The workflow id.
+     *
+     * Value may contain a UUID
+     */
+    workflowId: string;
+    /** Workflow run start time. */
+    startTime: string;
+    /**
+     * The person who submitted the user request.
+     *
+     * Value may contain a UUID
+     */
+    requestor: string;
+    /**
+     * The user request id.
+     *
+     * Value may contain a UUID
+     */
+    userRequestId?: string;
+    /** The input of a workflow run. Align with operation in user request. */
+    runPayload: WorkflowRunPayloadOutput;
+    /** The status. */
+    status: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
+    /** The time of workflow run completed. */
+    endTime?: string;
+    /** The time of workflow run be canceled. */
+    cancelTime?: string;
+    /** The comment when cancel a workflow run. */
+    cancelComment?: string;
+}
+/** The input of a workflow run. Align with operation in user request. */
+export interface WorkflowRunPayloadOutput {
+    /** The workflow run payload type. */
+    type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
+    /** The target value which need involve workflow to update. */
+    targetValue: string;
+}
+/** The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. */
+export interface WorkflowRunOutput {
+    /**
+     * The workflow run id.
+     *
+     * Value may contain a UUID
+     */
+    id?: string;
+    /**
+     * The workflow id.
+     *
+     * Value may contain a UUID
+     */
+    workflowId?: string;
+    /** Workflow run start time. */
+    startTime?: string;
+    /**
+     * The person who submitted the user request.
+     *
+     * Value may contain a UUID
+     */
+    requestor?: string;
+    /**
+     * The user request id.
+     *
+     * Value may contain a UUID
+     */
+    userRequestId?: string;
+    /** The input of a workflow run. Align with operation in user request. */
+    runPayload?: WorkflowRunRunPayloadOutput;
+    /** The status. */
+    status?: "NotStarted" | "InProgress" | "Failed" | "Completed" | "Canceling" | "CancellationFailed" | "Canceled";
+    /** The time of workflow run completed. */
+    endTime?: string;
+    /** The time of workflow run be canceled. */
+    cancelTime?: string;
+    /** The comment when cancel a workflow run. */
+    cancelComment?: string;
+    /** The action DAG(Directed Acyclic Graph), it defines actual flow. */
+    actionDag: Record<string, unknown>;
+    /** It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. */
+    detail: WorkflowRunDetailOutput;
+}
+/** The input of a workflow run. Align with operation in user request. */
+export interface WorkflowRunRunPayloadOutput {
+    /** The workflow run payload type. */
+    type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
+    /** The target value which need involve workflow to update. */
+    targetValue: string;
+    /** The payload of each operation which user want to submit. */
+    payload: Record<string, unknown>;
+}
+/** It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. */
+export interface WorkflowRunDetailOutput {
+    /** Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. */
+    runInput: Record<string, unknown>;
+    /** Any object */
+    actions: Record<string, unknown>;
+}
+export interface TasksListOutput {
+    /** The value of workflow tasks list. */
+    value: Array<WorkflowTaskOutput>;
+    /** The URL to get the next set of results. */
+    nextLink?: string;
+}
+/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */
+export interface WorkflowTaskOutputParent {
+    /**
+     * The workflow task id.
+     *
+     * Value may contain a UUID
+     */
+    id: string;
+    /** The workflow task title. */
+    title?: string;
+    /**
+     * The workflow run id.
+     *
+     * Value may contain a UUID
+     */
+    workflowRunId: string;
+    /**
+     * The workflow id.
+     *
+     * Value may contain a UUID
+     */
+    workflowId: string;
+    /**
+     * The person who submitted the user request.
+     *
+     * Value may contain a UUID
+     */
+    requestor: string;
+    /** The created time. */
+    createdTime: string;
+    /** The last update time. */
+    lastUpdateTime: string;
+    /** Info and material that helps assignees to take action. */
+    payload: TaskPayloadOutput;
+    /** Info of task reminder. */
+    reminderInfo?: WorkflowTaskReminderInfoOutput;
+    /** Info of task expiry. */
+    expiryInfo?: WorkflowTaskExpiryInfoOutput;
+    type: "WorkflowTask" | "Approval" | "SimpleTask";
+}
+/** Info and material that helps assignees to take action. */
+export interface TaskPayloadOutput {
+    /** The task payload type. */
+    type: "CreateTerm" | "UpdateTerm" | "DeleteTerm" | "ImportTerms" | "UpdateAsset" | "GrantDataAccess";
+    /** The target value of entity which user want to involve workflow to update. */
+    targetValue: string;
+    /** The payload of the task. */
+    payload?: Record<string, unknown>;
+}
+/** Info of task reminder. */
+export interface WorkflowTaskReminderInfoOutput {
+    /** The last update time. */
+    lastRemindTime?: string;
+    /** The next remind time. */
+    nextRemindTime: string;
+    /** The reminder settings. */
+    reminderSettings: Record<string, unknown>;
+}
+/** Info of task expiry. */
+export interface WorkflowTaskExpiryInfoOutput {
+    /** The last expiry notification time. */
+    lastExpiryNotificationTime?: string;
+    /** The next expiry notification time. */
+    nextExpiryNotificationTime: string;
+    /** The expiry time. */
+    expiryTime: string;
+    expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;
+}
+export interface WorkflowTaskExpiryInfoExpirySettingsOutput {
+    /** The time of expiry. */
+    expireAfter: Record<string, unknown>;
+    notifyOnExpiration?: Array<string>;
+}
+/** The workflow approval task properties. */
+export interface ApprovalOutput extends WorkflowTaskOutputParent {
+    /** The approval task details */
+    approvalDetail?: ApprovalDetailOutput;
+    type: "Approval";
+}
+/** The approval task details */
+export interface ApprovalDetailOutput {
+    /** The approval type of an approval task. */
+    approvalType: "PendingOnAny" | "PendingOnAll";
+    /** The status of an approval task. */
+    status: "Pending" | "Approved" | "Rejected" | "Canceled";
+    /** The list of approvers with reply. */
+    approvers: Record<string, ApproverResponseOutput>;
+}
+/** The response of approvers for a workflow task. */
+export interface ApproverResponseOutput {
+    /** The response for an approval task. */
+    reply: "Approved" | "Rejected" | "Pending";
+    /** The comment of approving or rejecting an approval request. */
+    comment?: string;
+    /** The reply time of approver to a workflow task. */
+    responseTime?: string;
+}
+/** The workflow simple task properties. */
+export interface SimpleTaskOutput extends WorkflowTaskOutputParent {
+    /** Workflow simple task details. */
+    taskDetail?: SimpleTaskDetailOutput;
+    type: "SimpleTask";
+}
+/** Workflow simple task details. */
+export interface SimpleTaskDetailOutput {
+    /** The simple task body. */
+    taskBody: string;
+    /** The users or groups were assigned the simple task. */
+    assignedTo: Array<string>;
+    /** Simple task status. */
+    status: "NotStarted" | "InProgress" | "Completed" | "Canceled";
+    changeHistory: Array<Record<string, unknown>>;
+}
+/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */
+export type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;
+//# sourceMappingURL=outputModels.d.ts.map

package/dist/browser/outputModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,yBAAyB;AACzB,MAAM,WAAW,0BAA0B;IACzC,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACrC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,2DAA2D;AAC3D,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC/B,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,SAAS,EAAE,OAAO,CAAC;IACnB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,0DAA0D;AAC1D,MAAM,WAAW,aAAa;IAC5B,IAAI,EACA,iCAAiC,GACjC,iCAAiC,GACjC,+BAA+B,GAC/B,gCAAgC,GAChC,qCAAqC,GACrC,gCAAgC,CAAC;IACrC,oCAAoC;IACpC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,2BAA2B;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,mCAAmC;AACnC,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,KAAK,EAAE,gBAAgB,CAAC;CACzB;AAED,0BAA0B;AAC1B,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAClC,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yGAAyG;AACzG,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC5D,iHAAiH;IACjH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,wDAAwD;AACxD,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,kIAAkI;IAClI,UAAU,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,MAAM,EACF,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,WAAW,GACX,WAAW,GACX,oBAAoB,GACpB,UAAU,CAAC;CAChB;AAED,2CAA2C;AAC3C,MAAM,WAAW,uCAAuC;IACtD,0BAA0B;IAC1B,IAAI,EACA,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,iBAAiB,CAAC;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACxC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,uGAAuG;AACvG,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,UAAU,EAAE,wBAAwB,CAAC;IACrC,kBAAkB;IAClB,MAAM,EACF,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,WAAW,GACX,WAAW,GACX,oBAAoB,GACpB,UAAU,CAAC;IACf,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yEAAyE;AACzE,MAAM,WAAW,wBAAwB;IACvC,qCAAqC;IACrC,IAAI,EACA,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,iBAAiB,CAAC;IACtB,8DAA8D;IAC9D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,2KAA2K;AAC3K,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,UAAU,CAAC,EAAE,2BAA2B,CAAC;IACzC,kBAAkB;IAClB,MAAM,CAAC,EACH,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,WAAW,GACX,WAAW,GACX,oBAAoB,GACpB,UAAU,CAAC;IACf,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,kIAAkI;IAClI,MAAM,EAAE,uBAAuB,CAAC;CACjC;AAED,yEAAyE;AACzE,MAAM,WAAW,2BAA2B;IAC1C,qCAAqC;IACrC,IAAI,EACA,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,iBAAiB,CAAC;IACtB,8DAA8D;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,kIAAkI;AAClI,MAAM,WAAW,uBAAuB;IACtC,oHAAoH;IACpH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,iBAAiB;IACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,wCAAwC;IACxC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACjC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,4IAA4I;AAC5I,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,6DAA6D;IAC7D,OAAO,EAAE,iBAAiB,CAAC;IAC3B,6BAA6B;IAC7B,YAAY,CAAC,EAAE,8BAA8B,CAAC;IAC9C,2BAA2B;IAC3B,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAC1C,IAAI,EAAE,cAAc,GAAG,UAAU,GAAG,YAAY,CAAC;CAClD;AAED,6DAA6D;AAC7D,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,IAAI,EACA,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,iBAAiB,CAAC;IACtB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,6BAA6B;AAC7B,MAAM,WAAW,8BAA8B;IAC7C,4BAA4B;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,2BAA2B;AAC3B,MAAM,WAAW,4BAA4B;IAC3C,yCAAyC;IACzC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,yCAAyC;IACzC,0BAA0B,EAAE,MAAM,CAAC;IACnC,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,0CAA0C,CAAC;CAC5D;AAED,MAAM,WAAW,0CAA0C;IACzD,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpC;AAED,6CAA6C;AAC7C,MAAM,WAAW,cAAe,SAAQ,wBAAwB;IAC9D,gCAAgC;IAChC,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,gCAAgC;AAChC,MAAM,WAAW,oBAAoB;IACnC,6CAA6C;IAC7C,YAAY,EAAE,cAAc,GAAG,cAAc,CAAC;IAC9C,sCAAsC;IACtC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IACzD,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CACnD;AAED,qDAAqD;AACrD,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;IAC3C,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,2CAA2C;AAC3C,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB;IAChE,oCAAoC;IACpC,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,oCAAoC;AACpC,MAAM,WAAW,sBAAsB;IACrC,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,0BAA0B;IAC1B,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,CAAC;IAC/D,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC/C;AAED,4IAA4I;AAC5I,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,gBAAgB,CAAC"}

package/dist/browser/outputModels.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=outputModels.js.map

package/{dist-esm/src → dist/browser}/outputModels.js.map

@@ -1 +1 @@
-{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** The workflow list. */\nexport interface WorkflowMetadataListOutput {\n  /** The value of workflow list. */\n  value: Array<WorkflowMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The workflow metadata, action DAGs are not included. */\nexport interface WorkflowMetadataOutput {\n  /**\n   * The id of workflow.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<TriggerOutput>;\n  /** The created time of workflow. */\n  createdTime?: string;\n  /** The person who created the workflow. */\n  createdBy?: string;\n  /** The last update time. */\n  lastUpdateTime?: string;\n  /** The person who updated the workflow. */\n  updatedBy?: string;\n  /** The name of a workflow. */\n  name: string;\n  /** Whether the workflow is enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n}\n\n/** Describes under what condition a workflow will run. */\nexport interface TriggerOutput {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Default error response model */\nexport interface ErrorResponseOutput {\n  /** Default error model */\n  error: ErrorModelOutput;\n}\n\n/** Default error model */\nexport interface ErrorModelOutput {\n  /** Gets or sets the code. */\n  code: string;\n  /** Gets or sets the details. */\n  details?: Array<ErrorModelOutput>;\n  /** Gets or sets the messages. */\n  message: string;\n  /** Gets or sets the target. */\n  target?: string;\n}\n\n/** The workflow properties. It includes the triggers, actual flow and other properties of a workflow. */\nexport interface WorkflowOutput extends WorkflowMetadataOutput {\n  /** The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order. */\n  actionDag: Record<string, unknown>;\n}\n\n/** Describes user ask to do operation(s) on Purview. */\nexport interface UserRequestResponseOutput {\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  requestId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<UserRequestResponseOperationsItemOutput>;\n  /** The comment when submit a user request. */\n  comment?: string;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n}\n\n/** The operation user wants to perform. */\nexport interface UserRequestResponseOperationsItemOutput {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n  workflowRunIds?: Array<string>;\n}\n\nexport interface WorkflowRunListOutput {\n  /** The value of workflow run list. */\n  value: Array<WorkflowRunMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The execution of a workflow. It includes status of the entire run and other properties of a run. */\nexport interface WorkflowRunMetadataOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /** Workflow run start time. */\n  startTime: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload: WorkflowRunPayloadOutput;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n}\n\n/** The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. */\nexport interface WorkflowRunOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id?: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId?: string;\n  /** Workflow run start time. */\n  startTime?: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor?: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload?: WorkflowRunRunPayloadOutput;\n  /** The status. */\n  status?:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag: Record<string, unknown>;\n  /** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\n  detail: WorkflowRunDetailOutput;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\n/** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\nexport interface WorkflowRunDetailOutput {\n  /** Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. */\n  runInput: Record<string, unknown>;\n  /** Any object */\n  actions: Record<string, unknown>;\n}\n\nexport interface TasksListOutput {\n  /** The value of workflow tasks list. */\n  value: Array<WorkflowTaskOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport interface WorkflowTaskOutputParent {\n  /**\n   * The workflow task id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** The workflow task title. */\n  title?: string;\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  workflowRunId: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The created time. */\n  createdTime: string;\n  /** The last update time. */\n  lastUpdateTime: string;\n  /** Info and material that helps assignees to take action. */\n  payload: TaskPayloadOutput;\n  /** Info of task reminder. */\n  reminderInfo?: WorkflowTaskReminderInfoOutput;\n  /** Info of task expiry. */\n  expiryInfo?: WorkflowTaskExpiryInfoOutput;\n  type: \"WorkflowTask\" | \"Approval\" | \"SimpleTask\";\n}\n\n/** Info and material that helps assignees to take action. */\nexport interface TaskPayloadOutput {\n  /** The task payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value of entity which user want to involve workflow to update. */\n  targetValue: string;\n  /** The payload of the task. */\n  payload?: Record<string, unknown>;\n}\n\n/** Info of task reminder. */\nexport interface WorkflowTaskReminderInfoOutput {\n  /** The last update time. */\n  lastRemindTime?: string;\n  /** The next remind time. */\n  nextRemindTime: string;\n  /** The reminder settings. */\n  reminderSettings: Record<string, unknown>;\n}\n\n/** Info of task expiry. */\nexport interface WorkflowTaskExpiryInfoOutput {\n  /** The last expiry notification time. */\n  lastExpiryNotificationTime?: string;\n  /** The next expiry notification time. */\n  nextExpiryNotificationTime: string;\n  /** The expiry time. */\n  expiryTime: string;\n  expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;\n}\n\nexport interface WorkflowTaskExpiryInfoExpirySettingsOutput {\n  /** The time of expiry. */\n  expireAfter: Record<string, unknown>;\n  notifyOnExpiration?: Array<string>;\n}\n\n/** The workflow approval task properties. */\nexport interface ApprovalOutput extends WorkflowTaskOutputParent {\n  /** The approval task details */\n  approvalDetail?: ApprovalDetailOutput;\n  type: \"Approval\";\n}\n\n/** The approval task details */\nexport interface ApprovalDetailOutput {\n  /** The approval type of an approval task. */\n  approvalType: \"PendingOnAny\" | \"PendingOnAll\";\n  /** The status of an approval task. */\n  status: \"Pending\" | \"Approved\" | \"Rejected\" | \"Canceled\";\n  /** The list of approvers with reply. */\n  approvers: Record<string, ApproverResponseOutput>;\n}\n\n/** The response of approvers for a workflow task. */\nexport interface ApproverResponseOutput {\n  /** The response for an approval task. */\n  reply: \"Approved\" | \"Rejected\" | \"Pending\";\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n  /** The reply time of approver to a workflow task. */\n  responseTime?: string;\n}\n\n/** The workflow simple task properties. */\nexport interface SimpleTaskOutput extends WorkflowTaskOutputParent {\n  /** Workflow simple task details. */\n  taskDetail?: SimpleTaskDetailOutput;\n  type: \"SimpleTask\";\n}\n\n/** Workflow simple task details. */\nexport interface SimpleTaskDetailOutput {\n  /** The simple task body. */\n  taskBody: string;\n  /** The users or groups were assigned the simple task. */\n  assignedTo: Array<string>;\n  /** Simple task status. */\n  status: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  changeHistory: Array<Record<string, unknown>>;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;\n"]}
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** The workflow list. */\nexport interface WorkflowMetadataListOutput {\n  /** The value of workflow list. */\n  value: Array<WorkflowMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The workflow metadata, action DAGs are not included. */\nexport interface WorkflowMetadataOutput {\n  /**\n   * The id of workflow.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** It describes under what condition a workflow will run.  */\n  triggers: Array<TriggerOutput>;\n  /** The created time of workflow. */\n  createdTime?: string;\n  /** The person who created the workflow. */\n  createdBy?: string;\n  /** The last update time. */\n  lastUpdateTime?: string;\n  /** The person who updated the workflow. */\n  updatedBy?: string;\n  /** The name of a workflow. */\n  name: string;\n  /** Whether the workflow is enabled or not. */\n  isEnabled: boolean;\n  /** Description of a workflow. */\n  description: string;\n}\n\n/** Describes under what condition a workflow will run. */\nexport interface TriggerOutput {\n  type:\n    | \"when_term_creation_is_requested\"\n    | \"when_term_deletion_is_requested\"\n    | \"when_term_update_is_requested\"\n    | \"when_terms_import_is_requested\"\n    | \"when_data_access_grant_is_requested\"\n    | \"when_asset_update_is_requested\";\n  /** Glossary term hierarchy path. */\n  underGlossaryHierarchy?: string;\n  /** The collection name. */\n  underCollection?: string;\n  /** The glossary guid. */\n  underGlossary?: string;\n}\n\n/** Default error response model */\nexport interface ErrorResponseOutput {\n  /** Default error model */\n  error: ErrorModelOutput;\n}\n\n/** Default error model */\nexport interface ErrorModelOutput {\n  /** Gets or sets the code. */\n  code: string;\n  /** Gets or sets the details. */\n  details?: Array<ErrorModelOutput>;\n  /** Gets or sets the messages. */\n  message: string;\n  /** Gets or sets the target. */\n  target?: string;\n}\n\n/** The workflow properties. It includes the triggers, actual flow and other properties of a workflow. */\nexport interface WorkflowOutput extends WorkflowMetadataOutput {\n  /** The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order. */\n  actionDag: Record<string, unknown>;\n}\n\n/** Describes user ask to do operation(s) on Purview. */\nexport interface UserRequestResponseOutput {\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  requestId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly. */\n  operations: Array<UserRequestResponseOperationsItemOutput>;\n  /** The comment when submit a user request. */\n  comment?: string;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n}\n\n/** The operation user wants to perform. */\nexport interface UserRequestResponseOperationsItemOutput {\n  /** The operation type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n  workflowRunIds?: Array<string>;\n}\n\nexport interface WorkflowRunListOutput {\n  /** The value of workflow run list. */\n  value: Array<WorkflowRunMetadataOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** The execution of a workflow. It includes status of the entire run and other properties of a run. */\nexport interface WorkflowRunMetadataOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /** Workflow run start time. */\n  startTime: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload: WorkflowRunPayloadOutput;\n  /** The status. */\n  status:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n}\n\n/** The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. */\nexport interface WorkflowRunOutput {\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  id?: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId?: string;\n  /** Workflow run start time. */\n  startTime?: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor?: string;\n  /**\n   * The user request id.\n   *\n   * Value may contain a UUID\n   */\n  userRequestId?: string;\n  /** The input of a workflow run. Align with operation in user request. */\n  runPayload?: WorkflowRunRunPayloadOutput;\n  /** The status. */\n  status?:\n    | \"NotStarted\"\n    | \"InProgress\"\n    | \"Failed\"\n    | \"Completed\"\n    | \"Canceling\"\n    | \"CancellationFailed\"\n    | \"Canceled\";\n  /** The time of workflow run completed. */\n  endTime?: string;\n  /** The time of workflow run be canceled. */\n  cancelTime?: string;\n  /** The comment when cancel a workflow run. */\n  cancelComment?: string;\n  /** The action DAG(Directed Acyclic Graph), it defines actual flow. */\n  actionDag: Record<string, unknown>;\n  /** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\n  detail: WorkflowRunDetailOutput;\n}\n\n/** The input of a workflow run. Align with operation in user request. */\nexport interface WorkflowRunRunPayloadOutput {\n  /** The workflow run payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value which need involve workflow to update. */\n  targetValue: string;\n  /** The payload of each operation which user want to submit. */\n  payload: Record<string, unknown>;\n}\n\n/** It refers to the \"detail\" property of a workflow run object, which contains run context and runtime information of actions. */\nexport interface WorkflowRunDetailOutput {\n  /** Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time. */\n  runInput: Record<string, unknown>;\n  /** Any object */\n  actions: Record<string, unknown>;\n}\n\nexport interface TasksListOutput {\n  /** The value of workflow tasks list. */\n  value: Array<WorkflowTaskOutput>;\n  /** The URL to get the next set of results. */\n  nextLink?: string;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport interface WorkflowTaskOutputParent {\n  /**\n   * The workflow task id.\n   *\n   * Value may contain a UUID\n   */\n  id: string;\n  /** The workflow task title. */\n  title?: string;\n  /**\n   * The workflow run id.\n   *\n   * Value may contain a UUID\n   */\n  workflowRunId: string;\n  /**\n   * The workflow id.\n   *\n   * Value may contain a UUID\n   */\n  workflowId: string;\n  /**\n   * The person who submitted the user request.\n   *\n   * Value may contain a UUID\n   */\n  requestor: string;\n  /** The created time. */\n  createdTime: string;\n  /** The last update time. */\n  lastUpdateTime: string;\n  /** Info and material that helps assignees to take action. */\n  payload: TaskPayloadOutput;\n  /** Info of task reminder. */\n  reminderInfo?: WorkflowTaskReminderInfoOutput;\n  /** Info of task expiry. */\n  expiryInfo?: WorkflowTaskExpiryInfoOutput;\n  type: \"WorkflowTask\" | \"Approval\" | \"SimpleTask\";\n}\n\n/** Info and material that helps assignees to take action. */\nexport interface TaskPayloadOutput {\n  /** The task payload type. */\n  type:\n    | \"CreateTerm\"\n    | \"UpdateTerm\"\n    | \"DeleteTerm\"\n    | \"ImportTerms\"\n    | \"UpdateAsset\"\n    | \"GrantDataAccess\";\n  /** The target value of entity which user want to involve workflow to update. */\n  targetValue: string;\n  /** The payload of the task. */\n  payload?: Record<string, unknown>;\n}\n\n/** Info of task reminder. */\nexport interface WorkflowTaskReminderInfoOutput {\n  /** The last update time. */\n  lastRemindTime?: string;\n  /** The next remind time. */\n  nextRemindTime: string;\n  /** The reminder settings. */\n  reminderSettings: Record<string, unknown>;\n}\n\n/** Info of task expiry. */\nexport interface WorkflowTaskExpiryInfoOutput {\n  /** The last expiry notification time. */\n  lastExpiryNotificationTime?: string;\n  /** The next expiry notification time. */\n  nextExpiryNotificationTime: string;\n  /** The expiry time. */\n  expiryTime: string;\n  expirySettings: WorkflowTaskExpiryInfoExpirySettingsOutput;\n}\n\nexport interface WorkflowTaskExpiryInfoExpirySettingsOutput {\n  /** The time of expiry. */\n  expireAfter: Record<string, unknown>;\n  notifyOnExpiration?: Array<string>;\n}\n\n/** The workflow approval task properties. */\nexport interface ApprovalOutput extends WorkflowTaskOutputParent {\n  /** The approval task details */\n  approvalDetail?: ApprovalDetailOutput;\n  type: \"Approval\";\n}\n\n/** The approval task details */\nexport interface ApprovalDetailOutput {\n  /** The approval type of an approval task. */\n  approvalType: \"PendingOnAny\" | \"PendingOnAll\";\n  /** The status of an approval task. */\n  status: \"Pending\" | \"Approved\" | \"Rejected\" | \"Canceled\";\n  /** The list of approvers with reply. */\n  approvers: Record<string, ApproverResponseOutput>;\n}\n\n/** The response of approvers for a workflow task. */\nexport interface ApproverResponseOutput {\n  /** The response for an approval task. */\n  reply: \"Approved\" | \"Rejected\" | \"Pending\";\n  /** The comment of approving or rejecting an approval request. */\n  comment?: string;\n  /** The reply time of approver to a workflow task. */\n  responseTime?: string;\n}\n\n/** The workflow simple task properties. */\nexport interface SimpleTaskOutput extends WorkflowTaskOutputParent {\n  /** Workflow simple task details. */\n  taskDetail?: SimpleTaskDetailOutput;\n  type: \"SimpleTask\";\n}\n\n/** Workflow simple task details. */\nexport interface SimpleTaskDetailOutput {\n  /** The simple task body. */\n  taskBody: string;\n  /** The users or groups were assigned the simple task. */\n  assignedTo: Array<string>;\n  /** Simple task status. */\n  status: \"NotStarted\" | \"InProgress\" | \"Completed\" | \"Canceled\";\n  changeHistory: Array<Record<string, unknown>>;\n}\n\n/** An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. */\nexport type WorkflowTaskOutput = ApprovalOutput | SimpleTaskOutput;\n"]}

package/dist/browser/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/browser/paginateHelper.d.ts

@@ -0,0 +1,68 @@
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * An interface that tracks the settings for paged iteration
+ */
+export interface PageSettings {
+    /**
+     * The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    /**
+     * The next method, part of the iteration protocol
+     */
+    next(): Promise<IteratorResult<TElement>>;
+    /**
+     * The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    /**
+     * Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+}
+/**
+ * Helper type to extract the type of an array
+ */
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+/**
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
+ */
+export type GetPage<TPage> = (pageLink: string) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+    /**
+     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+     */
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is `value`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+//# sourceMappingURL=paginateHelper.d.ts.map

package/dist/browser/paginateHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAuF7E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CACzC,QAAQ,EACR,KAAK,GAAG,QAAQ,EAAE,EAClB,aAAa,GAAG,YAAY;IAE5B;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,0BAA0B,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IACrF;;OAEG;IACH,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa,KAAK,qBAAqB,CAAC,KAAK,CAAC,CAAC;CACpE;AAyBD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IACpD,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACG,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA0BvD"}

package/{dist-esm/src → dist/browser}/paginateHelper.js

@@ -1,7 +1,74 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { getPagedAsyncIterator } from "@azure/core-paging";
+// Licensed under the MIT License.
 import { createRestError } from "@azure-rest/core-client";
+/**
+ * returns an async iterator that iterates over results. It also has a `byPage`
+ * method that returns pages of items at once.
+ *
+ * @param pagedResult - an object that specifies how to get pages.
+ * @returns a paged async iterator that iterates over results.
+ */
+function getPagedAsyncIterator(pagedResult) {
+    const iter = getItemAsyncIterator(pagedResult);
+    return {
+        next() {
+            return iter.next();
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+        byPage: pagedResult?.byPage ??
+            ((settings) => {
+                const { continuationToken } = settings ?? {};
+                return getPageAsyncIterator(pagedResult, {
+                    pageLink: continuationToken,
+                });
+            }),
+    };
+}
+async function* getItemAsyncIterator(pagedResult) {
+    const pages = getPageAsyncIterator(pagedResult);
+    const firstVal = await pages.next();
+    // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is
+    if (!Array.isArray(firstVal.value)) {
+        // can extract elements from this page
+        const { toElements } = pagedResult;
+        if (toElements) {
+            yield* toElements(firstVal.value);
+            for await (const page of pages) {
+                yield* toElements(page);
+            }
+        }
+        else {
+            yield firstVal.value;
+            // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case
+            yield* pages;
+        }
+    }
+    else {
+        yield* firstVal.value;
+        for await (const page of pages) {
+            // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,
+            // it must be the case that `TPage = TElement[]`
+            yield* page;
+        }
+    }
+}
+async function* getPageAsyncIterator(pagedResult, options = {}) {
+    const { pageLink } = options;
+    let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);
+    if (!response) {
+        return;
+    }
+    yield response.page;
+    while (response.nextPageLink) {
+        response = await pagedResult.getPage(response.nextPageLink);
+        if (!response) {
+            return;
+        }
+        yield response.page;
+    }
+}
 /**
  * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
  * @param client - Client to use for sending the next page requests
@@ -56,7 +123,7 @@ function getElements(body, itemName) {
     if (!Array.isArray(value)) {
         throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
     }
-    return value !== null && value !== void 0 ? value : [];
+    return value ?? [];
 }
 /**
  * Checks if a request failed

package/dist/browser/paginateHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;;;;;GAMG;AACH,SAAS,qBAAqB,CAM5B,WAAqD;IAErD,MAAM,IAAI,GAAG,oBAAoB,CAAwC,WAAW,CAAC,CAAC;IACtF,OAAO;QACL,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC;QACD,CAAC,MAAM,CAAC,aAAa,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,EACJ,WAAW,EAAE,MAAM;YAClB,CAAC,CAAC,QAAuB,EAAE,EAAE;gBAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;gBAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;oBACvC,QAAQ,EAAE,iBAAiD;iBAC5D,CAAC,CAAC;YACL,CAAC,CAA2E;KAC/E,CAAC;AACJ,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAqD;IAErD,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IACpC,6FAA6F;IAC7F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,sCAAsC;QACtC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAe,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBAC/B,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAe,CAAC;YACxC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,CAAC,KAAK,CAAC;YACrB,sFAAsF;YACtF,KAAK,CAAC,CAAC,KAAmD,CAAC;QAC7D,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QACtB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC/B,gGAAgG;YAChG,gDAAgD;YAChD,KAAK,CAAC,CAAC,IAA6B,CAAC;QACvC,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAqD,EACrD,UAEI,EAAE;IAEN,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;IAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IACD,MAAM,QAAQ,CAAC,IAAI,CAAC;IACpB,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC7B,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;AACH,CAAC;AA6FD;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,MAAM,QAAQ,GAAG,OAAO,CAAC;IACzB,MAAM,YAAY,GAAG,UAAU,CAAC;IAChC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,WAAW,GAA4B;QAC3C,aAAa,EAAE,EAAE;QACjB,OAAO,EACL,OAAO,aAAa,KAAK,UAAU;YACjC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE;gBACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;gBACvF,QAAQ,GAAG,KAAK,CAAC;gBACjB,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACxD,MAAM,MAAM,GAAG,WAAW,CAAW,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC5D,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,YAAY,EAAE,QAAQ;iBACvB,CAAC;YACJ,CAAC;KACR,CAAC;IAEF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,YAAqB;IACvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAI,IAAgC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,iBAAiB,YAAY,kCAAkC,CAAC,CAAC;IACnF,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAc,IAAa,EAAE,QAAgB;IAC/D,MAAM,KAAK,GAAI,IAAgC,CAAC,QAAQ,CAAQ,CAAC;IAEjE,qEAAqE;IACrE,qEAAqE;IACrE,iDAAiD;IACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B;IACzD,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\n\n/**\n * returns an async iterator that iterates over results. It also has a `byPage`\n * method that returns pages of items at once.\n *\n * @param pagedResult - an object that specifies how to get pages.\n * @returns a paged async iterator that iterates over results.\n */\nfunction getPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings,\n  TLink = string,\n>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const iter = getItemAsyncIterator<TElement, TPage, TLink, TPageSettings>(pagedResult);\n  return {\n    next() {\n      return iter.next();\n    },\n    [Symbol.asyncIterator]() {\n      return this;\n    },\n    byPage:\n      pagedResult?.byPage ??\n      (((settings?: PageSettings) => {\n        const { continuationToken } = settings ?? {};\n        return getPageAsyncIterator(pagedResult, {\n          pageLink: continuationToken as unknown as TLink | undefined,\n        });\n      }) as unknown as (settings?: TPageSettings) => AsyncIterableIterator<TPage>),\n  };\n}\n\nasync function* getItemAsyncIterator<TElement, TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n): AsyncIterableIterator<TElement> {\n  const pages = getPageAsyncIterator(pagedResult);\n  const firstVal = await pages.next();\n  // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is\n  if (!Array.isArray(firstVal.value)) {\n    // can extract elements from this page\n    const { toElements } = pagedResult;\n    if (toElements) {\n      yield* toElements(firstVal.value) as TElement[];\n      for await (const page of pages) {\n        yield* toElements(page) as TElement[];\n      }\n    } else {\n      yield firstVal.value;\n      // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case\n      yield* pages as unknown as AsyncIterableIterator<TElement>;\n    }\n  } else {\n    yield* firstVal.value;\n    for await (const page of pages) {\n      // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,\n      // it must be the case that `TPage = TElement[]`\n      yield* page as unknown as TElement[];\n    }\n  }\n}\n\nasync function* getPageAsyncIterator<TPage, TLink, TPageSettings>(\n  pagedResult: PagedResult<TPage, TPageSettings, TLink>,\n  options: {\n    pageLink?: TLink;\n  } = {},\n): AsyncIterableIterator<TPage> {\n  const { pageLink } = options;\n  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);\n  if (!response) {\n    return;\n  }\n  yield response.page;\n  while (response.nextPageLink) {\n    response = await pagedResult.getPage(response.nextPageLink);\n    if (!response) {\n      return;\n    }\n    yield response.page;\n  }\n}\n\n/**\n * An interface that tracks the settings for paged iteration\n */\nexport interface PageSettings {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n}\n\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings,\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\ninterface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink: TLink;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (pageLink: TLink) => Promise<{ page: TPage; nextPageLink?: TLink } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => unknown[];\n}\n\n/**\n * Helper type to extract the type of an array\n */\nexport type GetArrayType<T> = T extends Array<infer TData> ? TData : never;\n\n/**\n * The type of a custom function that defines how to get a page and a link to the next one if any.\n */\nexport type GetPage<TPage> = (pageLink: string) => Promise<{\n  page: TPage;\n  nextPageLink?: string;\n}>;\n\n/**\n * Options for the paging helper\n */\nexport interface PagingOptions<TResponse> {\n  /**\n   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator\n   */\n  customGetPage?: GetPage<PaginateReturn<TResponse>[]>;\n}\n\n/**\n * Helper type to infer the Type of the paged elements from the response type\n * This type is generated based on the swagger information for x-ms-pageable\n * specifically on the itemName property which indicates the property of the response\n * where the page items are found. The default value is `value`.\n * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter\n */\nexport type PaginateReturn<TResult> = TResult extends {\n  body: { value?: infer TPage };\n}\n  ? GetArrayType<TPage>\n  : Array<unknown>;\n\n/**\n * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension\n * @param client - Client to use for sending the next page requests\n * @param initialResponse - Initial response containing the nextLink and current page of elements\n * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results\n * @returns - PagedAsyncIterableIterator to iterate the elements\n */\nexport function paginate<TResponse extends PathUncheckedResponse>(\n  client: Client,\n  initialResponse: TResponse,\n  options: PagingOptions<TResponse> = {},\n): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {\n  // Extract element type from initial response\n  type TElement = PaginateReturn<TResponse>;\n  let firstRun = true;\n  const itemName = \"value\";\n  const nextLinkName = \"nextLink\";\n  const { customGetPage } = options;\n  const pagedResult: PagedResult<TElement[]> = {\n    firstPageLink: \"\",\n    getPage:\n      typeof customGetPage === \"function\"\n        ? customGetPage\n        : async (pageLink: string) => {\n            const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();\n            firstRun = false;\n            checkPagingRequest(result);\n            const nextLink = getNextLink(result.body, nextLinkName);\n            const values = getElements<TElement>(result.body, itemName);\n            return {\n              page: values,\n              nextPageLink: nextLink,\n            };\n          },\n  };\n\n  return getPagedAsyncIterator(pagedResult);\n}\n\n/**\n * Gets for the value of nextLink in the body\n */\nfunction getNextLink(body: unknown, nextLinkName?: string): string | undefined {\n  if (!nextLinkName) {\n    return undefined;\n  }\n\n  const nextLink = (body as Record<string, unknown>)[nextLinkName];\n\n  if (typeof nextLink !== \"string\" && typeof nextLink !== \"undefined\") {\n    throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);\n  }\n\n  return nextLink;\n}\n\n/**\n * Gets the elements of the current request in the body.\n */\nfunction getElements<T = unknown>(body: unknown, itemName: string): T[] {\n  const value = (body as Record<string, unknown>)[itemName] as T[];\n\n  // value has to be an array according to the x-ms-pageable extension.\n  // The fact that this must be an array is used above to calculate the\n  // type of elements in the page in PaginateReturn\n  if (!Array.isArray(value)) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${itemName}`,\n    );\n  }\n\n  return value ?? [];\n}\n\n/**\n * Checks if a request failed\n */\nfunction checkPagingRequest(response: PathUncheckedResponse): void {\n  const Http2xxStatusCodes = [\"200\", \"201\", \"202\", \"203\", \"204\", \"205\", \"206\", \"207\", \"208\", \"226\"];\n  if (!Http2xxStatusCodes.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n"]}