@azure/data-tables 12.1.3-alpha.20211015.2 → 12.2.0-alpha.20211027.1

package/dist-esm/src/utils/continuationToken.js

@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { base64Encode, base64Decode } from "./bufferSerializer";
+/**
+ * Encodes the nextPartitionKey and nextRowKey into a single continuation token
+ */
+export function encodeContinuationToken(nextPartitionKey = "", nextRowKey = "") {
+    if (!nextPartitionKey && !nextRowKey) {
+        return undefined;
+    }
+    const continuationToken = JSON.stringify({
+        nextPartitionKey,
+        nextRowKey
+    });
+    return base64Encode(continuationToken);
+}
+/**
+ * Decodes a continuationToken into an object containing a nextPartitionKey and nextRowKey
+ */
+export function decodeContinuationToken(encodedToken) {
+    const decodedToken = base64Decode(encodedToken);
+    let tokenStr = "";
+    for (const byte of decodedToken) {
+        tokenStr += String.fromCharCode(byte);
+    }
+    const continuationToken = JSON.parse(tokenStr);
+    return continuationToken;
+}
+//# sourceMappingURL=continuationToken.js.map

package/dist-esm/src/utils/continuationToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"continuationToken.js","sourceRoot":"","sources":["../../../src/utils/continuationToken.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOhE;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,mBAA2B,EAAE,EAC7B,aAAqB,EAAE;IAEvB,IAAI,CAAC,gBAAgB,IAAI,CAAC,UAAU,EAAE;QACpC,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACvC,gBAAgB;QAChB,UAAU;KACX,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC,iBAAiB,CAAC,CAAC;AACzC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAoB;IAC1D,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAChD,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE;QAC/B,QAAQ,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;KACvC;IACD,MAAM,iBAAiB,GAAsB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAElE,OAAO,iBAAiB,CAAC;AAC3B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { base64Encode, base64Decode } from \"./bufferSerializer\";\n\nexport interface ContinuationToken {\n  nextPartitionKey: string;\n  nextRowKey: string;\n}\n\n/**\n * Encodes the nextPartitionKey and nextRowKey into a single continuation token\n */\nexport function encodeContinuationToken(\n  nextPartitionKey: string = \"\",\n  nextRowKey: string = \"\"\n): string | undefined {\n  if (!nextPartitionKey && !nextRowKey) {\n    return undefined;\n  }\n\n  const continuationToken = JSON.stringify({\n    nextPartitionKey,\n    nextRowKey\n  });\n\n  return base64Encode(continuationToken);\n}\n\n/**\n * Decodes a continuationToken into an object containing a nextPartitionKey and nextRowKey\n */\nexport function decodeContinuationToken(encodedToken: string): ContinuationToken {\n  const decodedToken = base64Decode(encodedToken);\n  let tokenStr = \"\";\n\n  for (const byte of decodedToken) {\n    tokenStr += String.fromCharCode(byte);\n  }\n  const continuationToken: ContinuationToken = JSON.parse(tokenStr);\n\n  return continuationToken;\n}\n"]}

package/dist-esm/src/utils/internalModels.js.map

@@ -1 +1 @@
-{"version":3,"file":"internalModels.js","sourceRoot":"","sources":["../../../src/utils/internalModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  TableServiceClientOptions,\n  TableEntity,\n  CreateTableEntityResponse,\n  DeleteTableEntityOptions,\n  GetTableEntityOptions,\n  GetTableEntityResponse,\n  ListTableEntitiesOptions,\n  UpdateMode,\n  UpdateTableEntityOptions,\n  TableEntityResult,\n  TableItem,\n  TransactionAction,\n  TableTransactionResponse\n} from \"../models\";\nimport { Pipeline, PipelineRequest } from \"@azure/core-rest-pipeline\";\nimport { NamedKeyCredential } from \"@azure/core-auth\";\nimport { DeleteTableEntityResponse, UpdateEntityResponse, UpsertEntityResponse } from \"..\";\nimport { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { OperationOptions } from \"@azure/core-client\";\n\nexport interface ConnectionString {\n  kind: \"AccountConnString\" | \"SASConnString\";\n  url: string;\n  accountName: string;\n  accountKey?: any;\n  accountSas?: string;\n}\n\n/**\n * Contains response data for the listTable operation.\n */\nexport type ListTableItemsResponse = Array<TableItem> & {\n  /**\n   * This header contains the continuation token value.\n   */\n  nextTableName?: string;\n};\n\n/**\n * Contains response data for the getEntity operation.\n */\nexport type ListEntitiesResponse<T extends object> = Array<TableEntityResult<T>> & {\n  /**\n   * Contains the continuation token value for partition key.\n   */\n  nextPartitionKey?: string;\n  /**\n   * Contains the continuation token value for row key.\n   */\n  nextRowKey?: string;\n};\n\nexport interface ClientParamsFromConnectionString {\n  url: string;\n  options?: TableServiceClientOptions;\n  credential?: NamedKeyCredential;\n}\n\n/**\n * Transaction request builder\n */\nexport interface InnerTransactionRequest {\n  /**\n   * Transaction request body\n   */\n  body: string[];\n  /**\n   * Creates a pipeline to intercept sub-requests and\n   * build the request body\n   */\n  createPipeline(): Pipeline;\n  /**\n   * Adds an operation to add to the transaction body\n   * @param request - The operation to add\n   */\n  appendSubRequestToBody(request: PipelineRequest): void;\n  /**\n   * Gets the transaction request body\n   */\n  getHttpRequestBody(): string;\n}\n\nexport interface InternalTransactionClientOptions extends TableServiceClientOptions {\n  innerTransactionRequest: InnerTransactionRequest;\n}\n\n/**\n * Describes the shape of a TableClient\n */\nexport interface TableClientLike {\n  /**\n   * Represents a pipeline for making a HTTP request to a URL.\n   */\n  pipeline: Pipeline;\n  /**\n   * Name of the table to perform operations on.\n   */\n  readonly tableName: string;\n  /**\n   *  Creates the current table.\n   * @param options - The options parameters.\n   */\n  createTable(options?: OperationOptions): Promise<void>;\n  /**\n   * Submits a Transaction which is composed of a set of actions.\n   * @param actions - tuple that contains the action to perform, and the entity to perform the action with\n   */\n  submitTransaction(actions: TransactionAction[]): Promise<TableTransactionResponse>;\n  /**\n   * Insert entity in the table.\n   * @param entity - The properties for the table entity.\n   * @param options - The options parameters.\n   */\n  createEntity<T extends object>(\n    entity: TableEntity<T>,\n    options?: OperationOptions\n  ): Promise<CreateTableEntityResponse>;\n  /**\n   * Permanently deletes the current table with all of its entities.\n   * @param options - The options parameters.\n   */\n  deleteTable(options?: OperationOptions): Promise<void>;\n  /**\n   * Permanently deletes the current table if it exists in the account.\n   * @param options - The options parameters.\n   */\n  deleteEntity(\n    partitionKey: string,\n    rowKey: string,\n    options?: DeleteTableEntityOptions\n  ): Promise<DeleteTableEntityResponse>;\n  /**\n   * Returns a single entity in the table.\n   * @param partitionKey - The partition key of the entity.\n   * @param rowKey - The row key of the entity.\n   * @param options - The options parameters.\n   */\n  getEntity<T extends object>(\n    partitionKey: string,\n    rowKey: string,\n    options?: GetTableEntityOptions\n  ): Promise<GetTableEntityResponse<T>>;\n  /**\n   * Queries entities in a table.\n   * @param tableName - The name of the table.\n   * @param options - The options parameters.\n   */\n  listEntities<T extends object>(\n    options?: ListTableEntitiesOptions\n  ): PagedAsyncIterableIterator<T, ListEntitiesResponse<T>>;\n  /**\n   * Update an entity in the table.\n   * @param entity - The properties of the entity to be updated.\n   * @param mode - The different modes for updating the entity:\n   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.\n   *               - Replace: Updates an existing entity by replacing the entire entity.\n   * @param options - The options parameters.\n   */\n  updateEntity<T extends object>(\n    entity: TableEntity<T>,\n    mode: UpdateMode,\n    options?: UpdateTableEntityOptions\n  ): Promise<UpdateEntityResponse>;\n  /**\n   * Upsert an entity in the table.\n   * @param tableName - The name of the table.\n   * @param entity - The properties for the table entity.\n   * @param mode - The different modes for updating the entity:\n   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.\n   *               - Replace: Updates an existing entity by replacing the entire entity.\n   * @param options - The options parameters.\n   */\n  upsertEntity<T extends object>(\n    entity: TableEntity<T>,\n    mode: UpdateMode,\n    options?: OperationOptions\n  ): Promise<UpsertEntityResponse>;\n}\n"]}
+{"version":3,"file":"internalModels.js","sourceRoot":"","sources":["../../../src/utils/internalModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  TableServiceClientOptions,\n  TableEntity,\n  CreateTableEntityResponse,\n  DeleteTableEntityOptions,\n  GetTableEntityOptions,\n  GetTableEntityResponse,\n  ListTableEntitiesOptions,\n  UpdateMode,\n  UpdateTableEntityOptions,\n  TableEntityResult,\n  TableItem,\n  TransactionAction,\n  TableTransactionResponse\n} from \"../models\";\nimport { Pipeline, PipelineRequest } from \"@azure/core-rest-pipeline\";\nimport { NamedKeyCredential } from \"@azure/core-auth\";\nimport { DeleteTableEntityResponse, UpdateEntityResponse, UpsertEntityResponse } from \"..\";\nimport { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { OperationOptions } from \"@azure/core-client\";\n\nexport interface ConnectionString {\n  kind: \"AccountConnString\" | \"SASConnString\";\n  url: string;\n  accountName: string;\n  accountKey?: any;\n  accountSas?: string;\n}\n\n/**\n * Contains response data for the listTable operation.\n */\nexport type ListTableItemsResponse = Array<TableItem> & {\n  /**\n   * This header contains the continuation token value.\n   */\n  nextTableName?: string;\n};\n\n/**\n * Contains response data for the getEntity operation.\n */\nexport type ListEntitiesResponse<T extends object> = Array<TableEntityResult<T>> & {\n  /**\n   * Contains the continuation token value for the next page.\n   */\n  continuationToken?: string;\n};\n\nexport interface ClientParamsFromConnectionString {\n  url: string;\n  options?: TableServiceClientOptions;\n  credential?: NamedKeyCredential;\n}\n\n/**\n * Transaction request builder\n */\nexport interface InnerTransactionRequest {\n  /**\n   * Transaction request body\n   */\n  body: string[];\n  /**\n   * Creates a pipeline to intercept sub-requests and\n   * build the request body\n   */\n  createPipeline(): Pipeline;\n  /**\n   * Adds an operation to add to the transaction body\n   * @param request - The operation to add\n   */\n  appendSubRequestToBody(request: PipelineRequest): void;\n  /**\n   * Gets the transaction request body\n   */\n  getHttpRequestBody(): string;\n}\n\nexport interface InternalTransactionClientOptions extends TableServiceClientOptions {\n  innerTransactionRequest: InnerTransactionRequest;\n}\n\n/**\n * Describes the shape of a TableClient\n */\nexport interface TableClientLike {\n  /**\n   * Represents a pipeline for making a HTTP request to a URL.\n   */\n  pipeline: Pipeline;\n  /**\n   * Name of the table to perform operations on.\n   */\n  readonly tableName: string;\n  /**\n   *  Creates the current table.\n   * @param options - The options parameters.\n   */\n  createTable(options?: OperationOptions): Promise<void>;\n  /**\n   * Submits a Transaction which is composed of a set of actions.\n   * @param actions - tuple that contains the action to perform, and the entity to perform the action with\n   */\n  submitTransaction(actions: TransactionAction[]): Promise<TableTransactionResponse>;\n  /**\n   * Insert entity in the table.\n   * @param entity - The properties for the table entity.\n   * @param options - The options parameters.\n   */\n  createEntity<T extends object>(\n    entity: TableEntity<T>,\n    options?: OperationOptions\n  ): Promise<CreateTableEntityResponse>;\n  /**\n   * Permanently deletes the current table with all of its entities.\n   * @param options - The options parameters.\n   */\n  deleteTable(options?: OperationOptions): Promise<void>;\n  /**\n   * Permanently deletes the current table if it exists in the account.\n   * @param options - The options parameters.\n   */\n  deleteEntity(\n    partitionKey: string,\n    rowKey: string,\n    options?: DeleteTableEntityOptions\n  ): Promise<DeleteTableEntityResponse>;\n  /**\n   * Returns a single entity in the table.\n   * @param partitionKey - The partition key of the entity.\n   * @param rowKey - The row key of the entity.\n   * @param options - The options parameters.\n   */\n  getEntity<T extends object>(\n    partitionKey: string,\n    rowKey: string,\n    options?: GetTableEntityOptions\n  ): Promise<GetTableEntityResponse<T>>;\n  /**\n   * Queries entities in a table.\n   * @param tableName - The name of the table.\n   * @param options - The options parameters.\n   */\n  listEntities<T extends object>(\n    options?: ListTableEntitiesOptions\n  ): PagedAsyncIterableIterator<T, ListEntitiesResponse<T>>;\n  /**\n   * Update an entity in the table.\n   * @param entity - The properties of the entity to be updated.\n   * @param mode - The different modes for updating the entity:\n   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.\n   *               - Replace: Updates an existing entity by replacing the entire entity.\n   * @param options - The options parameters.\n   */\n  updateEntity<T extends object>(\n    entity: TableEntity<T>,\n    mode: UpdateMode,\n    options?: UpdateTableEntityOptions\n  ): Promise<UpdateEntityResponse>;\n  /**\n   * Upsert an entity in the table.\n   * @param tableName - The name of the table.\n   * @param entity - The properties for the table entity.\n   * @param mode - The different modes for updating the entity:\n   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.\n   *               - Replace: Updates an existing entity by replacing the entire entity.\n   * @param options - The options parameters.\n   */\n  upsertEntity<T extends object>(\n    entity: TableEntity<T>,\n    mode: UpdateMode,\n    options?: OperationOptions\n  ): Promise<UpsertEntityResponse>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/data-tables",
-  "version": "12.1.3-alpha.20211015.2",
+  "version": "12.2.0-alpha.20211027.1",
   "description": "An isomorphic client library for the Azure Tables service.",
   "sdk-type": "client",
   "main": "dist/index.js",

package/types/3.1/data-tables.d.ts

@@ -595,7 +595,7 @@ export declare class TableClient {
      * }
      * ```
      */
-    listEntities<T extends object = Record<string, unknown>>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResult<T>[]>;
+    listEntities<T extends object = Record<string, unknown>>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>>;
     private listEntitiesAll;
     private listEntitiesPage;
     private _listEntities;
@@ -774,7 +774,6 @@ export declare class TableClient {
      * @param actions - tuple that contains the action to perform, and the entity to perform the action with
      */
     submitTransaction(actions: TransactionAction[]): Promise<TableTransactionResponse>;
-    private convertQueryOptions;
     /**
      *
      * Creates an instance of TableClient from connection string.
@@ -873,6 +872,15 @@ export declare type TableEntityResult<T> = T & {
      */
     timestamp?: string;
 };
+/**
+ * Output page type for query operations
+ */
+export declare type TableEntityResultPage<T> = Array<TableEntityResult<T>> & {
+    /**
+     * Continuation token to get the next page
+     */
+    continuationToken?: string;
+};
 /** Defines headers for Table_getAccessPolicy operation. */
 export declare interface TableGetAccessPolicyHeaders {
     /** If a client request id header is sent in the request, this header will be present in the response with the same value. */

package/types/latest/data-tables.d.ts

@@ -635,7 +635,7 @@ export declare class TableClient {
      * }
      * ```
      */
-    listEntities<T extends object = Record<string, unknown>>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResult<T>[]>;
+    listEntities<T extends object = Record<string, unknown>>(options?: ListTableEntitiesOptions): PagedAsyncIterableIterator<TableEntityResult<T>, TableEntityResultPage<T>>;
     private listEntitiesAll;
     private listEntitiesPage;
     private _listEntities;
@@ -814,7 +814,6 @@ export declare class TableClient {
      * @param actions - tuple that contains the action to perform, and the entity to perform the action with
      */
     submitTransaction(actions: TransactionAction[]): Promise<TableTransactionResponse>;
-    private convertQueryOptions;
     /**
      *
      * Creates an instance of TableClient from connection string.
@@ -920,6 +919,16 @@ export declare type TableEntityResult<T> = T & {
     timestamp?: string;
 };
 
+/**
+ * Output page type for query operations
+ */
+export declare type TableEntityResultPage<T> = Array<TableEntityResult<T>> & {
+    /**
+     * Continuation token to get the next page
+     */
+    continuationToken?: string;
+};
+
 /** Defines headers for Table_getAccessPolicy operation. */
 export declare interface TableGetAccessPolicyHeaders {
     /** If a client request id header is sent in the request, this header will be present in the response with the same value. */

package/types/latest/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.15"
+      "packageVersion": "7.18.16"
     }
   ]
 }