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

package/dist/commonjs/metadataPolicies/models.d.ts

@@ -0,0 +1,58 @@
+/** Attribute matcher for a rule */
+export interface AttributeMatcher {
+    /** AttributeName */
+    attributeName?: string;
+    /** Value for attribute */
+    attributeValueIncludes?: string;
+    /** List of values for attribute */
+    attributeValueIncludedIn?: Array<string>;
+    /** Value excluded for attribute */
+    attributeValueExcludes?: string;
+    /** List of values excluded for attribute */
+    attributeValueExcludedIn?: Array<string>;
+}
+export interface MetadataPolicy {
+    /** The name of policy */
+    name?: string;
+    /** The id of policy */
+    id?: string;
+    /** The version of policy */
+    version?: number;
+    properties?: MetadataPolicyProperties;
+}
+export interface MetadataPolicyProperties {
+    /** The description of policy */
+    description?: string;
+    /** The DecisionRules of policy */
+    decisionRules?: Array<DecisionRule>;
+    /** The AttributeRules of policy */
+    attributeRules?: Array<AttributeRule>;
+    /** The collection reference for a policy */
+    collection?: CollectionReference;
+    /** The parent collection of the policy */
+    parentCollectionName?: string;
+}
+/** The decision rule for a policy */
+export interface DecisionRule {
+    /** The effect for rule */
+    effect?: "Deny" | "Permit";
+    /** The dnf Condition for a rule */
+    dnfCondition?: Array<Array<AttributeMatcher>>;
+}
+/** The attribute rule for a policy */
+export interface AttributeRule {
+    /** The id for rule */
+    id?: string;
+    /** The name for rule */
+    name?: string;
+    /** The dnf Condition for a rule */
+    dnfCondition?: Array<Array<AttributeMatcher>>;
+}
+/** The collection reference for a policy */
+export interface CollectionReference {
+    /** The type of reference */
+    type?: string;
+    /** The name of reference */
+    referenceName?: string;
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/commonjs/metadataPolicies/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/metadataPolicies/models.ts"],"names":[],"mappings":"AAGA,mCAAmC;AACnC,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0BAA0B;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,mCAAmC;IACnC,wBAAwB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,mCAAmC;IACnC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,4CAA4C;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,wBAAwB,CAAC;CACvC;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,mCAAmC;IACnC,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,0CAA0C;IAC1C,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,qCAAqC;AACrC,MAAM,WAAW,YAAY;IAC3B,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC3B,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;CAC/C;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAa;IAC5B,sBAAsB;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;CAC/C;AAED,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IAClC,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/dist/commonjs/metadataPolicies/models.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=models.js.map

package/dist/commonjs/metadataPolicies/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/metadataPolicies/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Attribute matcher for a rule */\nexport interface AttributeMatcher {\n  /** AttributeName */\n  attributeName?: string;\n  /** Value for attribute */\n  attributeValueIncludes?: string;\n  /** List of values for attribute */\n  attributeValueIncludedIn?: Array<string>;\n  /** Value excluded for attribute */\n  attributeValueExcludes?: string;\n  /** List of values excluded for attribute */\n  attributeValueExcludedIn?: Array<string>;\n}\n\nexport interface MetadataPolicy {\n  /** The name of policy */\n  name?: string;\n  /** The id of policy */\n  id?: string;\n  /** The version of policy */\n  version?: number;\n  properties?: MetadataPolicyProperties;\n}\n\nexport interface MetadataPolicyProperties {\n  /** The description of policy */\n  description?: string;\n  /** The DecisionRules of policy */\n  decisionRules?: Array<DecisionRule>;\n  /** The AttributeRules of policy */\n  attributeRules?: Array<AttributeRule>;\n  /** The collection reference for a policy */\n  collection?: CollectionReference;\n  /** The parent collection of the policy */\n  parentCollectionName?: string;\n}\n\n/** The decision rule for a policy */\nexport interface DecisionRule {\n  /** The effect for rule */\n  effect?: \"Deny\" | \"Permit\";\n  /** The dnf Condition for a rule */\n  dnfCondition?: Array<Array<AttributeMatcher>>;\n}\n\n/** The attribute rule for a policy */\nexport interface AttributeRule {\n  /** The id for rule */\n  id?: string;\n  /** The name for rule */\n  name?: string;\n  /** The dnf Condition for a rule */\n  dnfCondition?: Array<Array<AttributeMatcher>>;\n}\n\n/** The collection reference for a policy */\nexport interface CollectionReference {\n  /** The type of reference */\n  type?: string;\n  /** The name of reference */\n  referenceName?: string;\n}\n"]}

package/dist/commonjs/metadataPolicies/outputModels.d.ts

@@ -0,0 +1,113 @@
+/** List of Metadata roles */
+export interface MetadataRoleListOutput {
+    values: Array<MetadataRoleOutput>;
+    nextLink?: string;
+}
+export interface MetadataRoleOutput {
+    /** The Id of role */
+    id?: string;
+    /** The name of role */
+    name?: string;
+    /** The type of role */
+    type?: string;
+    properties?: MetadataRolePropertiesOutput;
+}
+export interface MetadataRolePropertiesOutput {
+    /** The provisioningState of role */
+    provisioningState?: string;
+    /** The type of role */
+    roleType?: string;
+    /** The friendly name of role */
+    friendlyName?: string;
+    /** The description of role */
+    description?: string;
+    /** The cnf Condition for a rule */
+    cnfCondition?: Array<Array<AttributeMatcherOutput>>;
+    /** The dnf Condition for a rule */
+    dnfCondition?: Array<Array<AttributeMatcherOutput>>;
+    /** The version of role */
+    version?: number;
+}
+/** Attribute matcher for a rule */
+export interface AttributeMatcherOutput {
+    /** AttributeName */
+    attributeName?: string;
+    /** Value for attribute */
+    attributeValueIncludes?: string;
+    /** List of values for attribute */
+    attributeValueIncludedIn?: Array<string>;
+    /** Value excluded for attribute */
+    attributeValueExcludes?: string;
+    /** List of values excluded for attribute */
+    attributeValueExcludedIn?: Array<string>;
+}
+/** The error response model for metadata policy */
+export interface ErrorResponseModelOutput {
+    /** The error model for metadata policy */
+    error: ErrorModelOutput;
+}
+/** The error model for metadata policy */
+export interface ErrorModelOutput {
+    /** The error code */
+    code: string;
+    /** The error message */
+    message: string;
+    /** The error target */
+    target?: string;
+    /** The error details */
+    details?: Array<ErrorModelOutput>;
+}
+/** List of Metadata Policies */
+export interface MetadataPolicyListOutput {
+    values: Array<MetadataPolicyOutput>;
+    nextLink?: string;
+}
+export interface MetadataPolicyOutput {
+    /** The name of policy */
+    name?: string;
+    /** The id of policy */
+    id?: string;
+    /** The version of policy */
+    version?: number;
+    properties?: MetadataPolicyPropertiesOutput;
+}
+export interface MetadataPolicyPropertiesOutput {
+    /** The description of policy */
+    description?: string;
+    /** The DecisionRules of policy */
+    decisionRules?: Array<DecisionRuleOutput>;
+    /** The AttributeRules of policy */
+    attributeRules?: Array<AttributeRuleOutput>;
+    /** The collection reference for a policy */
+    collection?: CollectionReferenceOutput;
+    /** The parent collection of the policy */
+    parentCollectionName?: string;
+}
+/** The decision rule for a policy */
+export interface DecisionRuleOutput {
+    /** The kind of rule */
+    readonly kind?: "decisionrule" | "attributerule";
+    /** The effect for rule */
+    effect?: "Deny" | "Permit";
+    /** The dnf Condition for a rule */
+    dnfCondition?: Array<Array<AttributeMatcherOutput>>;
+}
+/** The attribute rule for a policy */
+export interface AttributeRuleOutput {
+    /** The kind of rule */
+    readonly kind?: "decisionrule" | "attributerule";
+    /** The id for rule */
+    id?: string;
+    /** The name for rule */
+    name?: string;
+    /** The dnf Condition for a rule */
+    dnfCondition?: Array<Array<AttributeMatcherOutput>>;
+}
+/** The collection reference for a policy */
+export interface CollectionReferenceOutput {
+    /** The type of reference */
+    type?: string;
+    /** The name of reference */
+    referenceName?: string;
+}
+//# sourceMappingURL=outputModels.d.ts.map

package/dist/commonjs/metadataPolicies/outputModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../../src/metadataPolicies/outputModels.ts"],"names":[],"mappings":"AAGA,6BAA6B;AAC7B,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,qBAAqB;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,4BAA4B,CAAC;CAC3C;AAED,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACpD,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACpD,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,mCAAmC;AACnC,MAAM,WAAW,sBAAsB;IACrC,oBAAoB;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0BAA0B;IAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,mCAAmC;IACnC,wBAAwB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzC,mCAAmC;IACnC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,4CAA4C;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED,mDAAmD;AACnD,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,KAAK,EAAE,gBAAgB,CAAC;CACzB;AAED,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACnC;AAED,gCAAgC;AAChC,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,8BAA8B,CAAC;CAC7C;AAED,MAAM,WAAW,8BAA8B;IAC7C,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,aAAa,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC1C,mCAAmC;IACnC,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5C,4CAA4C;IAC5C,UAAU,CAAC,EAAE,yBAAyB,CAAC;IACvC,0CAA0C;IAC1C,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IACjC,uBAAuB;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,eAAe,CAAC;IACjD,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC3B,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;CACrD;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAmB;IAClC,uBAAuB;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,eAAe,CAAC;IACjD,sBAAsB;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;CACrD;AAED,4CAA4C;AAC5C,MAAM,WAAW,yBAAyB;IACxC,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/dist/commonjs/metadataPolicies/outputModels.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=outputModels.js.map

package/dist/commonjs/metadataPolicies/outputModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../../src/metadataPolicies/outputModels.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** List of Metadata roles */\nexport interface MetadataRoleListOutput {\n  values: Array<MetadataRoleOutput>;\n  nextLink?: string;\n}\n\nexport interface MetadataRoleOutput {\n  /** The Id of role */\n  id?: string;\n  /** The name of role */\n  name?: string;\n  /** The type of role */\n  type?: string;\n  properties?: MetadataRolePropertiesOutput;\n}\n\nexport interface MetadataRolePropertiesOutput {\n  /** The provisioningState of role */\n  provisioningState?: string;\n  /** The type of role */\n  roleType?: string;\n  /** The friendly name of role */\n  friendlyName?: string;\n  /** The description of role */\n  description?: string;\n  /** The cnf Condition for a rule */\n  cnfCondition?: Array<Array<AttributeMatcherOutput>>;\n  /** The dnf Condition for a rule */\n  dnfCondition?: Array<Array<AttributeMatcherOutput>>;\n  /** The version of role */\n  version?: number;\n}\n\n/** Attribute matcher for a rule */\nexport interface AttributeMatcherOutput {\n  /** AttributeName */\n  attributeName?: string;\n  /** Value for attribute */\n  attributeValueIncludes?: string;\n  /** List of values for attribute */\n  attributeValueIncludedIn?: Array<string>;\n  /** Value excluded for attribute */\n  attributeValueExcludes?: string;\n  /** List of values excluded for attribute */\n  attributeValueExcludedIn?: Array<string>;\n}\n\n/** The error response model for metadata policy */\nexport interface ErrorResponseModelOutput {\n  /** The error model for metadata policy */\n  error: ErrorModelOutput;\n}\n\n/** The error model for metadata policy */\nexport interface ErrorModelOutput {\n  /** The error code */\n  code: string;\n  /** The error message */\n  message: string;\n  /** The error target */\n  target?: string;\n  /** The error details */\n  details?: Array<ErrorModelOutput>;\n}\n\n/** List of Metadata Policies */\nexport interface MetadataPolicyListOutput {\n  values: Array<MetadataPolicyOutput>;\n  nextLink?: string;\n}\n\nexport interface MetadataPolicyOutput {\n  /** The name of policy */\n  name?: string;\n  /** The id of policy */\n  id?: string;\n  /** The version of policy */\n  version?: number;\n  properties?: MetadataPolicyPropertiesOutput;\n}\n\nexport interface MetadataPolicyPropertiesOutput {\n  /** The description of policy */\n  description?: string;\n  /** The DecisionRules of policy */\n  decisionRules?: Array<DecisionRuleOutput>;\n  /** The AttributeRules of policy */\n  attributeRules?: Array<AttributeRuleOutput>;\n  /** The collection reference for a policy */\n  collection?: CollectionReferenceOutput;\n  /** The parent collection of the policy */\n  parentCollectionName?: string;\n}\n\n/** The decision rule for a policy */\nexport interface DecisionRuleOutput {\n  /** The kind of rule */\n  readonly kind?: \"decisionrule\" | \"attributerule\";\n  /** The effect for rule */\n  effect?: \"Deny\" | \"Permit\";\n  /** The dnf Condition for a rule */\n  dnfCondition?: Array<Array<AttributeMatcherOutput>>;\n}\n\n/** The attribute rule for a policy */\nexport interface AttributeRuleOutput {\n  /** The kind of rule */\n  readonly kind?: \"decisionrule\" | \"attributerule\";\n  /** The id for rule */\n  id?: string;\n  /** The name for rule */\n  name?: string;\n  /** The dnf Condition for a rule */\n  dnfCondition?: Array<Array<AttributeMatcherOutput>>;\n}\n\n/** The collection reference for a policy */\nexport interface CollectionReferenceOutput {\n  /** The type of reference */\n  type?: string;\n  /** The name of reference */\n  referenceName?: string;\n}\n"]}

package/dist/commonjs/metadataPolicies/paginateHelper.d.ts

@@ -0,0 +1,72 @@
+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;
+    };
+} | {
+    body: {
+        values?: 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/commonjs/metadataPolicies/paginateHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../../src/metadataPolicies/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,SACzC;IACE,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACD;IACE,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAChC,GACD,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,CA4BvD"}

package/dist/commonjs/metadataPolicies/paginateHelper.js

@@ -0,0 +1,173 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = paginate;
+const core_client_1 = require("@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
+ * @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
+ */
+function paginate(client, initialResponse, options = {}) {
+    let firstRun = true;
+    // We need to check the response for success before trying to inspect it looking for
+    // the properties to use for nextLink and itemName
+    checkPagingRequest(initialResponse);
+    const { itemName, nextLinkName } = getPaginationProperties(initialResponse);
+    const { customGetPage } = options;
+    const pagedResult = {
+        firstPageLink: "",
+        getPage: typeof customGetPage === "function"
+            ? customGetPage
+            : async (pageLink) => {
+                const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();
+                firstRun = false;
+                checkPagingRequest(result);
+                const nextLink = getNextLink(result.body, nextLinkName);
+                const values = getElements(result.body, itemName);
+                return {
+                    page: values,
+                    nextPageLink: nextLink,
+                };
+            },
+    };
+    return getPagedAsyncIterator(pagedResult);
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+        throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    // value has to be an array according to the x-ms-pageable extension.
+    // The fact that this must be an array is used above to calculate the
+    // type of elements in the page in PaginateReturn
+    if (!Array.isArray(value)) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value ?? [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response) {
+    const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
+    if (!Http2xxStatusCodes.includes(response.status)) {
+        throw (0, core_client_1.createRestError)(`Pagination failed with unexpected statusCode ${response.status}`, response);
+    }
+}
+/**
+ * Extracts the itemName and nextLinkName from the initial response to use them for pagination
+ */
+function getPaginationProperties(initialResponse) {
+    // Build a set with the passed custom nextLinkNames
+    const nextLinkNames = new Set(["nextLink"]);
+    // Build a set with the passed custom set of itemNames
+    const itemNames = new Set(["value", "values"]);
+    let nextLinkName;
+    let itemName;
+    for (const name of nextLinkNames) {
+        const nextLink = initialResponse.body[name];
+        if (nextLink) {
+            nextLinkName = name;
+            break;
+        }
+    }
+    for (const name of itemNames) {
+        const item = initialResponse.body[name];
+        if (item) {
+            itemName = name;
+            break;
+        }
+    }
+    if (!itemName) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${[
+            ...itemNames,
+        ].join(" OR ")}`);
+    }
+    return { itemName, nextLinkName };
+}
+//# sourceMappingURL=paginateHelper.js.map

package/dist/commonjs/metadataPolicies/paginateHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../../src/metadataPolicies/paginateHelper.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AA+LlC,4BAgCC;AA5ND,yDAA0D;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;AAiGD;;;;;;GAMG;AACH,SAAgB,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,oFAAoF;IACpF,kDAAkD;IAClD,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACpC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAC5E,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,IAAA,6BAAe,EACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,eAAsC;IAIrE,mDAAmD;IACnD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,sDAAsD;IACtD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE/C,IAAI,YAAgC,CAAC;IACrC,IAAI,QAA4B,CAAC;IAEjC,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAI,eAAe,CAAC,IAAgC,CAAC,IAAI,CAAW,CAAC;QACnF,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,GAAG,IAAI,CAAC;YACpB,MAAM;QACR,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAI,eAAe,CAAC,IAAgC,CAAC,IAAI,CAAW,CAAC;QAC/E,IAAI,IAAI,EAAE,CAAC;YACT,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,kFAAkF;YAChF,GAAG,SAAS;SACb,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;AACpC,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  | {\n      body: { value?: infer TPage };\n    }\n  | {\n      body: { values?: 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  // We need to check the response for success before trying to inspect it looking for\n  // the properties to use for nextLink and itemName\n  checkPagingRequest(initialResponse);\n  const { itemName, nextLinkName } = getPaginationProperties(initialResponse);\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\n/**\n * Extracts the itemName and nextLinkName from the initial response to use them for pagination\n */\nfunction getPaginationProperties(initialResponse: PathUncheckedResponse): {\n  itemName: string;\n  nextLinkName: string | undefined;\n} {\n  // Build a set with the passed custom nextLinkNames\n  const nextLinkNames = new Set([\"nextLink\"]);\n\n  // Build a set with the passed custom set of itemNames\n  const itemNames = new Set([\"value\", \"values\"]);\n\n  let nextLinkName: string | undefined;\n  let itemName: string | undefined;\n\n  for (const name of nextLinkNames) {\n    const nextLink = (initialResponse.body as Record<string, unknown>)[name] as string;\n    if (nextLink) {\n      nextLinkName = name;\n      break;\n    }\n  }\n\n  for (const name of itemNames) {\n    const item = (initialResponse.body as Record<string, unknown>)[name] as string;\n    if (item) {\n      itemName = name;\n      break;\n    }\n  }\n\n  if (!itemName) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${[\n        ...itemNames,\n      ].join(\" OR \")}`,\n    );\n  }\n\n  return { itemName, nextLinkName };\n}\n"]}

package/dist/commonjs/metadataPolicies/parameters.d.ts

@@ -0,0 +1,22 @@
+import type { RequestParameters } from "@azure-rest/core-client";
+import type { MetadataPolicy } from "./models.js";
+export type MetadataRolesListParameters = RequestParameters;
+export interface MetadataPolicyListAllQueryParamProperties {
+    /** The name of an existing collection for which one policy needs to be fetched. */
+    collectionName?: string;
+}
+export interface MetadataPolicyListAllQueryParam {
+    queryParameters?: MetadataPolicyListAllQueryParamProperties;
+}
+export type MetadataPolicyListAllParameters = MetadataPolicyListAllQueryParam & RequestParameters;
+export interface MetadataPolicyUpdateBodyParam {
+    /** Policy to be updated. */
+    body?: MetadataPolicy;
+}
+export interface MetadataPolicyUpdateMediaTypesParam {
+    /** Request content type */
+    contentType?: "application/json";
+}
+export type MetadataPolicyUpdateParameters = MetadataPolicyUpdateMediaTypesParam & MetadataPolicyUpdateBodyParam & RequestParameters;
+export type MetadataPolicyGetParameters = RequestParameters;
+//# sourceMappingURL=parameters.d.ts.map

package/dist/commonjs/metadataPolicies/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/metadataPolicies/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAE5D,MAAM,WAAW,yCAAyC;IACxD,mFAAmF;IACnF,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,+BAA+B;IAC9C,eAAe,CAAC,EAAE,yCAAyC,CAAC;CAC7D;AAED,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,GAAG,iBAAiB,CAAC;AAElG,MAAM,WAAW,6BAA6B;IAC5C,4BAA4B;IAC5B,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,mCAAmC;IAClD,2BAA2B;IAC3B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,MAAM,MAAM,8BAA8B,GAAG,mCAAmC,GAC9E,6BAA6B,GAC7B,iBAAiB,CAAC;AACpB,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC"}

package/dist/commonjs/metadataPolicies/parameters.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=parameters.js.map

package/dist/commonjs/metadataPolicies/parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../../src/metadataPolicies/parameters.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RequestParameters } from \"@azure-rest/core-client\";\nimport type { MetadataPolicy } from \"./models.js\";\n\nexport type MetadataRolesListParameters = RequestParameters;\n\nexport interface MetadataPolicyListAllQueryParamProperties {\n  /** The name of an existing collection for which one policy needs to be fetched. */\n  collectionName?: string;\n}\n\nexport interface MetadataPolicyListAllQueryParam {\n  queryParameters?: MetadataPolicyListAllQueryParamProperties;\n}\n\nexport type MetadataPolicyListAllParameters = MetadataPolicyListAllQueryParam & RequestParameters;\n\nexport interface MetadataPolicyUpdateBodyParam {\n  /** Policy to be updated. */\n  body?: MetadataPolicy;\n}\n\nexport interface MetadataPolicyUpdateMediaTypesParam {\n  /** Request content type */\n  contentType?: \"application/json\";\n}\n\nexport type MetadataPolicyUpdateParameters = MetadataPolicyUpdateMediaTypesParam &\n  MetadataPolicyUpdateBodyParam &\n  RequestParameters;\nexport type MetadataPolicyGetParameters = RequestParameters;\n"]}

package/dist/commonjs/metadataPolicies/purviewMetadataPolicies.d.ts

@@ -0,0 +1,16 @@
+import type { ClientOptions } from "@azure-rest/core-client";
+import type { TokenCredential } from "@azure/core-auth";
+import type { PurviewMetadataPoliciesClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface PurviewMetadataPoliciesClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `PurviewMetadataPoliciesClient`
+ * @param endpoint - The endpoint of your Purview account. Example: https://\{accountName\}.purview.azure.com.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export declare function createClient(endpoint: string, credentials: TokenCredential, { apiVersion, ...options }?: PurviewMetadataPoliciesClientOptions): PurviewMetadataPoliciesClient;
+//# sourceMappingURL=purviewMetadataPolicies.d.ts.map

package/dist/commonjs/metadataPolicies/purviewMetadataPolicies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"purviewMetadataPolicies.d.ts","sourceRoot":"","sources":["../../../src/metadataPolicies/purviewMetadataPolicies.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wBAAwB,CAAC;AAE5E,6CAA6C;AAC7C,MAAM,WAAW,oCAAqC,SAAQ,aAAa;IACzE,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,eAAe,EAC5B,EAAE,UAAiC,EAAE,GAAG,OAAO,EAAE,GAAE,oCAAyC,GAC3F,6BAA6B,CAuC/B"}

package/dist/commonjs/metadataPolicies/purviewMetadataPolicies.js

@@ -0,0 +1,48 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = createClient;
+const core_client_1 = require("@azure-rest/core-client");
+const logger_js_1 = require("../logger.js");
+/**
+ * Initialize a new instance of `PurviewMetadataPoliciesClient`
+ * @param endpoint - The endpoint of your Purview account. Example: https://\{accountName\}.purview.azure.com.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+function createClient(endpoint, credentials, { apiVersion = "2021-07-01-preview", ...options } = {}) {
+    const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpoint}/policyStore`;
+    const userAgentInfo = `azsdk-js-purview-administration-rest/1.0.0-beta.2`;
+    const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+        : `${userAgentInfo}`;
+    options = {
+        ...options,
+        userAgentOptions: {
+            userAgentPrefix,
+        },
+        loggingOptions: {
+            logger: options.loggingOptions?.logger ?? logger_js_1.logger.info,
+        },
+        credentials: {
+            scopes: ["https://purview.azure.net/.default"],
+        },
+    };
+    const client = (0, core_client_1.getClient)(endpointUrl, credentials, options);
+    client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
+    client.pipeline.addPolicy({
+        name: "ClientApiVersionPolicy",
+        sendRequest: (req, next) => {
+            // Use the apiVersion defined in request url directly
+            // Append one if there is no apiVersion and we have one at client options
+            const url = new URL(req.url);
+            if (!url.searchParams.get("api-version") && apiVersion) {
+                req.url = `${req.url}${Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
+            }
+            return next(req);
+        },
+    });
+    return client;
+}
+//# sourceMappingURL=purviewMetadataPolicies.js.map

package/dist/commonjs/metadataPolicies/purviewMetadataPolicies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"purviewMetadataPolicies.js","sourceRoot":"","sources":["../../../src/metadataPolicies/purviewMetadataPolicies.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAoBlC,oCA2CC;AA5DD,yDAAoD;AACpD,4CAAsC;AAUtC;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,QAAgB,EAChB,WAA4B,EAC5B,EAAE,UAAU,GAAG,oBAAoB,EAAE,GAAG,OAAO,KAA2C,EAAE;IAE5F,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,IAAI,GAAG,QAAQ,cAAc,CAAC;IACrF,MAAM,aAAa,GAAG,mDAAmD,CAAC;IAC1E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,GAAG;QACR,GAAG,OAAO;QACV,gBAAgB,EAAE;YAChB,eAAe;SAChB;QACD,cAAc,EAAE;YACd,MAAM,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,IAAI,kBAAM,CAAC,IAAI;SACtD;QACD,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,oCAAoC,CAAC;SAC/C;KACF,CAAC;IACF,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAkC,CAAC;IAE7F,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"../logger.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { PurviewMetadataPoliciesClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface PurviewMetadataPoliciesClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `PurviewMetadataPoliciesClient`\n * @param endpoint - The endpoint of your Purview account. Example: https://\\{accountName\\}.purview.azure.com.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport function createClient(\n  endpoint: string,\n  credentials: TokenCredential,\n  { apiVersion = \"2021-07-01-preview\", ...options }: PurviewMetadataPoliciesClientOptions = {},\n): PurviewMetadataPoliciesClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpoint}/policyStore`;\n  const userAgentInfo = `azsdk-js-purview-administration-rest/1.0.0-beta.2`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: [\"https://purview.azure.net/.default\"],\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as PurviewMetadataPoliciesClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}