diff --git a/sdk/appconfiguration/app-configuration/src/appConfigCredential.ts b/sdk/appconfiguration/app-configuration/src/appConfigCredential.ts index 2667a70fd396..5aafe6717ef3 100644 --- a/sdk/appconfiguration/app-configuration/src/appConfigCredential.ts +++ b/sdk/appconfiguration/app-configuration/src/appConfigCredential.ts @@ -6,6 +6,7 @@ import { sha256Digest, sha256Hmac } from "./internal/cryptoHelpers"; /** * @internal + * @hidden */ export class AppConfigCredential implements ServiceClientCredentials { private credential: string; diff --git a/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts b/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts index f5702ba6ebf0..844528dc3298 100644 --- a/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts +++ b/sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts @@ -66,6 +66,7 @@ const packageName = "azsdk-js-app-configuration"; * This constant should always be the same as the package.json's version - we use it when forming the * User - Agent header. There's a unit test that makes sure it always stays in sync. * @internal + * @hidden */ export const packageVersion = "1.1.1"; const apiVersion = "1.0"; @@ -101,6 +102,7 @@ export interface AppConfigurationClientOptions { /** * Provides internal configuration options for AppConfigurationClient. * @internal + * @hidden */ export interface InternalAppConfigurationClientOptions extends AppConfigurationClientOptions { /** @@ -507,6 +509,7 @@ export class AppConfigurationClient { /** * Gets the options for the generated AppConfigurationClient * @internal + * @hidden */ export function getGeneratedClientOptions( baseUri: string, @@ -542,6 +545,7 @@ export function getGeneratedClientOptions( /** * @internal + * @hidden */ export function getUserAgentPrefix(userSuppliedUserAgent: string | undefined): string { const appConfigDefaultUserAgent = `${packageName}/${packageVersion} ${getCoreHttpDefaultUserAgentValue()}`; diff --git a/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.browser.ts b/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.browser.ts index ea7c6073d6d7..14f16547eca5 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.browser.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.browser.ts @@ -5,6 +5,7 @@ /** * @internal + * @hidden */ export async function sha256Digest(body: string | undefined): Promise { const digest = await self.crypto.subtle.digest("SHA-256", new TextEncoder().encode(body || "")); @@ -16,6 +17,7 @@ export async function sha256Digest(body: string | undefined): Promise { /** * @internal + * @hidden */ export async function sha256Hmac(secret: string, stringToSign: string): Promise { const key = await self.crypto.subtle.importKey( diff --git a/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.ts b/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.ts index cb37adb9a4a4..e4bbc83be0d3 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/cryptoHelpers.ts @@ -5,6 +5,7 @@ import { createHash, createHmac } from "crypto"; /** * @internal + * @hidden */ export async function sha256Digest(body: string | undefined): Promise { return createHash("sha256") @@ -14,6 +15,7 @@ export async function sha256Digest(body: string | undefined): Promise { /** * @internal + * @hidden */ export async function sha256Hmac(secret: string, stringToSign: string): Promise { const decodedSecret = Buffer.from(secret, "base64"); diff --git a/sdk/appconfiguration/app-configuration/src/internal/helpers.ts b/sdk/appconfiguration/app-configuration/src/internal/helpers.ts index 96061a9d3b40..a56a0c61ecb8 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/helpers.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/helpers.ts @@ -17,6 +17,7 @@ import { AppConfigurationGetKeyValuesOptionalParams, KeyValue } from "../generat /** * Formats the etag so it can be used with a If-Match/If-None-Match header * @internal + * @hidden */ export function quoteETag(etag: string | undefined): string | undefined { // https://tools.ietf.org/html/rfc7232#section-3.1 @@ -40,6 +41,7 @@ export function quoteETag(etag: string | undefined): string | undefined { * and throws an Error. Otherwise, returns the properties properly quoted. * @param options - An options object with onlyIfChanged/onlyIfUnchanged fields * @internal + * @hidden */ export function checkAndFormatIfAndIfNoneMatch( configurationSetting: ConfigurationSettingId, @@ -71,6 +73,7 @@ export function checkAndFormatIfAndIfNoneMatch( * into the format the REST call will need. * * @internal + * @hidden */ export function formatWildcards( listConfigOptions: ListConfigurationSettingsOptions | ListRevisionsOptions @@ -105,6 +108,7 @@ export function formatWildcards( * Handles translating a Date acceptDateTime into a string as needed by the API * @param newOptions - A newer style options with acceptDateTime as a date (and with proper casing!) * @internal + * @hidden */ export function formatAcceptDateTime(newOptions: { acceptDateTime?: Date; @@ -118,6 +122,7 @@ export function formatAcceptDateTime(newOptions: { * Take the URL that gets returned from next link and extract the 'after' token needed * to get the next page of results. * @internal + * @hidden */ export function extractAfterTokenFromNextLink(nextLink: string) { const parsedLink = URLBuilder.parse(nextLink); @@ -157,6 +162,7 @@ export function makeConfigurationSettingEmpty( /** * @internal + * @hidden */ export function transformKeyValue(kvp: KeyValue): ConfigurationSetting { const obj: ConfigurationSetting & KeyValue = { @@ -170,6 +176,7 @@ export function transformKeyValue(kvp: KeyValue): ConfigurationSetting { /** * @internal + * @hidden */ export function transformKeyValueResponseWithStatusCode< T extends KeyValue & HttpResponseField @@ -184,6 +191,7 @@ export function transformKeyValueResponseWithStatusCode< /** * @internal + * @hidden */ export function transformKeyValueResponse< T extends KeyValue & { eTag?: string } & HttpResponseField diff --git a/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts b/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts index acb4747509d9..236dfc0f7139 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts @@ -14,6 +14,7 @@ import { * The sync token header, as described here: * https://github.com/Azure/AppConfiguration/blob/master/docs/REST/consistency.md * @internal + * @hidden */ export const SyncTokenHeaderName = "sync-token"; @@ -21,6 +22,7 @@ export const SyncTokenHeaderName = "sync-token"; * A policy factory for injecting sync tokens properly into outgoing requests. * @param syncTokens - the sync tokens store to be used across requests. * @internal + * @hidden */ export function syncTokenPolicy(syncTokens: SyncTokens): RequestPolicyFactory { return { @@ -60,6 +62,7 @@ class SyncTokenPolicy extends BaseRequestPolicy { * https://github.com/Azure/AppConfiguration/blob/master/docs/REST/consistency.md * * @internal + * @hidden */ export class SyncTokens { private _currentSyncTokens = new Map(); @@ -137,6 +140,7 @@ interface SyncToken { * @param syncToken - A single sync token. * * @internal + * @hidden */ export function parseSyncToken(syncToken: string): SyncToken { const matches = syncToken.match(syncTokenRegex); diff --git a/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts b/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts index b8650fd33dce..ba96c33d483b 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts @@ -9,6 +9,7 @@ import { RestError } from "@azure/core-http"; /** * @internal + * @hidden */ export interface Spannable { spanOptions?: SpanOptions; @@ -16,6 +17,7 @@ export interface Spannable { /** * @internal + * @hidden */ export class Spanner { constructor(private baseOperationName: string) {} diff --git a/sdk/appconfiguration/app-configuration/src/policies/throttlingRetryPolicy.ts b/sdk/appconfiguration/app-configuration/src/policies/throttlingRetryPolicy.ts index a5b209d1a235..3360c8ea355f 100644 --- a/sdk/appconfiguration/app-configuration/src/policies/throttlingRetryPolicy.ts +++ b/sdk/appconfiguration/app-configuration/src/policies/throttlingRetryPolicy.ts @@ -15,6 +15,7 @@ import { /** * @internal + * @hidden */ export function throttlingRetryPolicy(): RequestPolicyFactory { return { @@ -30,6 +31,7 @@ export function throttlingRetryPolicy(): RequestPolicyFactory { * responding to 429 responses (which is to throw a RestError). * * @internal + * @hidden */ export class ThrottlingRetryPolicy extends BaseRequestPolicy { constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions) { @@ -84,6 +86,7 @@ const RetryAfterMillisecondsHeaders: string[] = ["retry-after-ms", "x-ms-retry-a * Extracts the retry response header, checking against several * header names. * @internal + * @hidden */ export function getDelayInMs(responseHeaders: { get: (headerName: string) => string | undefined; diff --git a/sdk/appconfiguration/app-configuration/tsdoc.json b/sdk/appconfiguration/app-configuration/tsdoc.json new file mode 100644 index 000000000000..1665e79638d8 --- /dev/null +++ b/sdk/appconfiguration/app-configuration/tsdoc.json @@ -0,0 +1,6 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "extends": [ + "../../../tsdoc.json" + ] +} \ No newline at end of file