@azure/app-configuration-importer-file-source 1.0.0-preview → 1.0.1-preview

package/dist-esm/src/fileConfigurationSettingsSource.js

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import * as fs from "fs";
+import { StringConfigurationSettingsSource, ArgumentNullError } from "@azure/app-configuration-importer";
+/**
+ * ConfigurationSettingsSource implementation of file configuration source
+ */
+export class FileConfigurationSettingsSource extends StringConfigurationSettingsSource {
+    constructor(fileOptions) {
+        super(Object.assign({ data: "" }, fileOptions));
+        if (!fileOptions) {
+            throw new ArgumentNullError("fileOptions argument is required.");
+        }
+        if (!fileOptions.filePath || fileOptions.filePath.trim().length <= 0) {
+            throw new ArgumentNullError("fileOptions.filePath cannot be null or empty.");
+        }
+        this.filePath = fileOptions.filePath;
+    }
+    /**
+     * @inheritdoc
+     */
+    async GetConfigurationSettings() {
+        try {
+            const data = fs.readFileSync(this.filePath).toString();
+            return super.getConfigurationSettingsInternal(data);
+        }
+        catch (error) {
+            error.message = `Error while importing configuration settings from ${this.filePath}: ${error.message}`;
+            throw error;
+        }
+    }
+}
+//# sourceMappingURL=fileConfigurationSettingsSource.js.map

package/dist-esm/src/fileConfigurationSettingsSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileConfigurationSettingsSource.js","sourceRoot":"","sources":["../../src/fileConfigurationSettingsSource.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB,OAAO,EAAE,iCAAiC,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAEzG;;GAEG;AACH,MAAM,OAAO,+BAAgC,SAAQ,iCAAiC;IAGpF,YAAY,WAA8B;QACxC,KAAK,iBACH,IAAI,EAAE,EAAE,IACL,WAA4B,EAC/B,CAAC;QAEH,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,iBAAiB,CAAC,mCAAmC,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE;YACpE,MAAM,IAAI,iBAAiB,CAAC,+CAA+C,CAAC,CAAC;SAC9E;QAED,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IACvC,CAAC;IAED;;OAEG;IACa,KAAK,CAAC,wBAAwB;QAC5C,IAAI;YACF,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;SACrD;QACD,OAAO,KAAU,EAAE;YACjB,KAAK,CAAC,OAAO,GAAG,qDAAqD,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACvG,MAAM,KAAK,CAAC;SACb;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as fs from \"fs\";\nimport { SetConfigurationSettingParam, FeatureFlagValue, SecretReferenceValue } from \"@azure/app-configuration\";\nimport { FileSourceOptions, SourceOptions } from \"./fileSourceOptions\";\nimport { StringConfigurationSettingsSource, ArgumentNullError } from \"@azure/app-configuration-importer\";\n\n/**\n * ConfigurationSettingsSource implementation of file configuration source\n */\nexport class FileConfigurationSettingsSource extends StringConfigurationSettingsSource {\n  private filePath: string;\n\n  constructor(fileOptions: FileSourceOptions) {\n    super({\n      data: \"\",\n      ...fileOptions as SourceOptions\n    });\n\n    if (!fileOptions) {\n      throw new ArgumentNullError(\"fileOptions argument is required.\");\n    }\n\n    if (!fileOptions.filePath || fileOptions.filePath.trim().length <= 0) {\n      throw new ArgumentNullError(\"fileOptions.filePath cannot be null or empty.\");\n    }\n\n    this.filePath = fileOptions.filePath;\n  }\n\n  /**\n   * @inheritdoc\n   */\n  public override async GetConfigurationSettings(): Promise<SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[]> {\n    try {\n      const data = fs.readFileSync(this.filePath).toString();\n      return super.getConfigurationSettingsInternal(data);\n    }\n    catch (error: any) {\n      error.message = `Error while importing configuration settings from ${this.filePath}: ${error.message}`;\n      throw error;\n    }\n  }\n}"]}

package/dist-esm/src/fileSourceOptions.js

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

package/dist-esm/src/fileSourceOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSourceOptions.js","sourceRoot":"","sources":["../../src/fileSourceOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { ConfigurationFormat, ConfigurationProfile } from \"@azure/app-configuration-importer\";\nimport { Tags } from \"./tags\";\n/**\n * Base options for configuration import\n *\n * @internal\n */\nexport type SourceOptions = {\n    format: ConfigurationFormat;\n    separator?: string;\n    depth?: number;\n    profile?: ConfigurationProfile;\n    label?: string;\n    skipFeatureFlags?: boolean;\n    prefix?: string;\n    contentType?: string;\n    tags?: Tags;\n}\n\nexport type FileSourceOptions = SourceOptions & { filePath: string; };\n"]}

package/dist-esm/src/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export { FileConfigurationSettingsSource } from "./fileConfigurationSettingsSource";
+//# sourceMappingURL=index.js.map

package/dist-esm/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport { FileSourceOptions as FileConfigurationSyncOptions } from \"./fileSourceOptions\";\nexport { FileConfigurationSettingsSource } from \"./fileConfigurationSettingsSource\";\n"]}

package/dist-esm/src/tags.js

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

package/dist-esm/src/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport interface Tags {\n  [propertyName: string]: string;\n}"]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/app-configuration-importer-file-source",
   "author": "Microsoft Corporation",
   "description": "A client library for importing/exporting key-values between configuration file sources and Azure App Configuration service",
-  "version": "1.0.0-preview",
+  "version": "1.0.1-preview",
   "sdk-type": "client",
   "keywords": [
     "node",
@@ -13,6 +13,17 @@
   "main": "./dist/index.js",
   "module": "./dist-esm/src/index.js",
   "types": "./types/azure-app-configuration-importer-file-source.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist-esm/src/**/*.js",
+    "dist-esm/src/**/*.js.map",
+    "types/src/**/*d.ts",
+    "types/src/**/*d.ts.map",
+    "types/azure-app-configuration-importer-file-source.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "npm run clean && tsc -p . && rollup -c && api-extractor run --local",
     "test": "cross-env TS_NODE_PROJECT=\"tsconfig.test.json\" mocha -r ts-node/register 'tests/**/*.ts'",

package/types/src/fileConfigurationSettingsSource.d.ts

@@ -0,0 +1,15 @@
+import { SetConfigurationSettingParam, FeatureFlagValue, SecretReferenceValue } from "@azure/app-configuration";
+import { FileSourceOptions } from "./fileSourceOptions";
+import { StringConfigurationSettingsSource } from "@azure/app-configuration-importer";
+/**
+ * ConfigurationSettingsSource implementation of file configuration source
+ */
+export declare class FileConfigurationSettingsSource extends StringConfigurationSettingsSource {
+    private filePath;
+    constructor(fileOptions: FileSourceOptions);
+    /**
+     * @inheritdoc
+     */
+    GetConfigurationSettings(): Promise<SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[]>;
+}
+//# sourceMappingURL=fileConfigurationSettingsSource.d.ts.map

package/types/src/fileConfigurationSettingsSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileConfigurationSettingsSource.d.ts","sourceRoot":"","sources":["../../src/fileConfigurationSettingsSource.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChH,OAAO,EAAE,iBAAiB,EAAiB,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,iCAAiC,EAAqB,MAAM,mCAAmC,CAAC;AAEzG;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,iCAAiC;IACpF,OAAO,CAAC,QAAQ,CAAS;gBAEb,WAAW,EAAE,iBAAiB;IAiB1C;;OAEG;IACmB,wBAAwB,IAAI,OAAO,CAAC,4BAA4B,CAAC,MAAM,GAAG,gBAAgB,GAAG,oBAAoB,CAAC,EAAE,CAAC;CAU5I"}

package/types/src/fileSourceOptions.d.ts

@@ -0,0 +1,22 @@
+import { ConfigurationFormat, ConfigurationProfile } from "@azure/app-configuration-importer";
+import { Tags } from "./tags";
+/**
+ * Base options for configuration import
+ *
+ * @internal
+ */
+export type SourceOptions = {
+    format: ConfigurationFormat;
+    separator?: string;
+    depth?: number;
+    profile?: ConfigurationProfile;
+    label?: string;
+    skipFeatureFlags?: boolean;
+    prefix?: string;
+    contentType?: string;
+    tags?: Tags;
+};
+export type FileSourceOptions = SourceOptions & {
+    filePath: string;
+};
+//# sourceMappingURL=fileSourceOptions.d.ts.map

package/types/src/fileSourceOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSourceOptions.d.ts","sourceRoot":"","sources":["../../src/fileSourceOptions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9F,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;CACf,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;CAAE,CAAC"}

package/types/src/index.d.ts

@@ -0,0 +1,3 @@
+export { FileSourceOptions as FileConfigurationSyncOptions } from "./fileSourceOptions";
+export { FileConfigurationSettingsSource } from "./fileConfigurationSettingsSource";
+//# sourceMappingURL=index.d.ts.map

package/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,IAAI,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC"}

package/types/src/tags.d.ts

@@ -0,0 +1,4 @@
+export interface Tags {
+    [propertyName: string]: string;
+}
+//# sourceMappingURL=tags.d.ts.map

package/types/src/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,IAAI;IACnB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC"}

package/app-configuration-importer-file-source.test.log

@@ -1,20 +0,0 @@
-Invoking: cross-env TS_NODE_PROJECT="tsconfig.test.json" mocha -r ts-node/register 'tests/**/*.ts' 
-
-
-  File configuration source test
-    ✔ Throw argument error when set unexpected option when the profile is kvset
-    ✔ Throw argument error if format is not json when the profile is kvset
-    ✔ Throw argument error if depth is set but separator is not
-    ✔ Throw argument error if separator is not valid
-    ✔ Throw error if file is not UTF8 encode
-    ✔ Throw error if file is not valid json file
-    ✔ Throw error if file is not valid yaml file
-    ✔ Throw error if file content is not valid object
-    ✔ Throw error if format is not json when the contentType is json
-    ✔ Throw error if file path is empty or whitespace
-    ✔ Ignore comments in json file
-    ✔ Handle null value present in json file
-
-
-  12 passing (13ms)
-

package/dist/app-configuration-importer-file-source.api.md

@@ -1,30 +0,0 @@
-## API Report File for "@azure/app-configuration-importer-file-source"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { ConfigurationFormat } from '@azure/app-configuration-importer';
-import { ConfigurationProfile } from '@azure/app-configuration-importer';
-import { FeatureFlagValue } from '@azure/app-configuration';
-import { SecretReferenceValue } from '@azure/app-configuration';
-import { SetConfigurationSettingParam } from '@azure/app-configuration';
-import { StringConfigurationSettingsSource } from '@azure/app-configuration-importer';
-
-// @public
-export class FileConfigurationSettingsSource extends StringConfigurationSettingsSource {
-    constructor(fileOptions: FileConfigurationSyncOptions);
-    // (undocumented)
-    GetConfigurationSettings(): Promise<SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[]>;
-}
-
-// Warning: (ae-forgotten-export) The symbol "SourceOptions" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export type FileConfigurationSyncOptions = SourceOptions & {
-    filePath: string;
-};
-
-// (No @packageDocumentation comment for this package)
-
-```

package/types/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.0"
-    }
-  ]
-}