feat: npm publish --access public

Author: AlexStack

.npmignore

@@ -0,0 +1,15 @@
+# test .npmignore by run "npm pack" before run "npm publish"
+vendor
+node_modules
+node_lambda_layer
+.serverless
+.env
+example
+vercel.*
+serverless.*
+*.zip
+*.tgz
+*.gz
+*bak.js
+*BAK.js
+test

cloud-config.ts

@@ -0,0 +1,132 @@
+import AES from "crypto-js/aes";
+import encUtf8 from "crypto-js/enc-utf8";
+
+export interface CloudConfigData {
+  projectName: string;
+  groupName: string;
+  featureKey: string;
+  value: unknown;
+  valueType: string;
+  prodEnabled?: boolean;
+  devEnabled?: boolean;
+  valueEncrypted?: boolean;
+}
+
+export const CLOUD_CONFIG_DEFAULT_GROUP = "defaultGroup";
+export const CLOUD_CONFIG_DEFAULT_PROJECT = "defaultProject";
+
+const couldConfigSecretClient =
+  process.env.NEXT_PUBLIC_CLOUD_CONFIG_CLIENT_ENCRYPT_SECRET;
+
+const couldConfigSecretServer = process.env.CLOUD_CONFIG_SERVER_ENCRYPT_SECRET;
+
+export const IS_PROD = process.env.NODE_ENV === "production";
+
+export const decryptData = (
+  data: string,
+  cryptSecret: string
+): string | null => {
+  const decryptedText = AES.decrypt(data, cryptSecret);
+  if (!decryptedText) {
+    return null;
+  }
+  return decryptedText.toString(encUtf8);
+};
+
+export const parseSingleConfig = (
+  config: CloudConfigData,
+  serverSideOnly = false
+): CloudConfigData => {
+  if (!config.valueEncrypted) {
+    return config;
+  }
+  const cryptSecret = serverSideOnly
+    ? couldConfigSecretServer
+    : couldConfigSecretClient;
+  if (!cryptSecret) {
+    // eslint-disable-next-line no-console
+    console.log(
+      `Can't decrypt featureKey ${config.featureKey}, Please set ${
+        serverSideOnly
+          ? "CLOUD_CONFIG_SERVER_ENCRYPT_SECRET"
+          : "NEXT_PUBLIC_CLOUD_CONFIG_CLIENT_ENCRYPT_SECRET"
+      } in .env`
+    );
+    return config;
+  }
+  const decryptedValue = decryptData(config.value as string, cryptSecret);
+  if (!decryptedValue) {
+    return config;
+  }
+
+  let newValue;
+  if (config.valueType === "json") {
+    try {
+      newValue = JSON.parse(decryptedValue);
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.log("JSON.parse(decryptedValue) error", config.value, error);
+    }
+  }
+  if (config.valueType === "array") {
+    newValue = decryptedValue.split(",").map((tag) => tag.trim());
+  }
+  if (config.valueType === "number") {
+    newValue = parseFloat(decryptedValue);
+  }
+  if (config.valueType === "boolean") {
+    newValue = Boolean(decryptedValue);
+  }
+
+  const newConfig = {
+    ...config,
+    value: newValue || decryptedValue,
+  };
+
+  return newConfig;
+};
+
+export const parseAllConfigs = (
+  configs: CloudConfigData[],
+  serverSideOnly = false
+): CloudConfigData[] => {
+  return configs.map((config) => parseSingleConfig(config, serverSideOnly));
+};
+
+interface GetCloudConfigParams {
+  featureKey: string;
+  groupName?: string;
+  projectName?: string;
+  configs: CloudConfigData[];
+}
+
+export const getCloudConfig = <T>({
+  featureKey,
+  groupName = CLOUD_CONFIG_DEFAULT_GROUP,
+  projectName = CLOUD_CONFIG_DEFAULT_PROJECT,
+  configs,
+}: GetCloudConfigParams) => {
+  const config = configs.find((item) => {
+    if (item.featureKey !== featureKey) {
+      return false;
+    }
+    if (item.groupName !== groupName) {
+      return false;
+    }
+    if (item.projectName !== projectName) {
+      return false;
+    }
+    return true;
+  });
+  if (!config) {
+    return null;
+  }
+  if (IS_PROD && !config.prodEnabled) {
+    return null;
+  }
+  if (!IS_PROD && !config.devEnabled) {
+    return null;
+  }
+
+  return config.value as T;
+};

index.ts

@@ -0,0 +1 @@
+export * from "./cloud-config";

package-lock.json

@@ -0,0 +1,27 @@
+{
+  "name": "cloud-configuration",
+  "version": "0.1.0",
+  "description": "This package allows you to use CloudConfig easily.",
+  "author": "Alex Zeng",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlexStack/cloud-config-package.git"
+  },
+  "keywords": [],
+  "bugs": {
+    "url": "https://github.com/AlexStack/cloud-config-package/issues"
+  },
+  "homepage": "https://github.com/AlexStack/cloud-config-package#readme",
+  "devDependencies": {
+    "@types/crypto-js": "^4.1.2",
+    "@types/node": "^20.8.2"
+  },
+  "dependencies": {
+    "crypto-js": "^4.1.1"
+  }
+}

package.json

@@ -0,0 +1,3 @@
+import { decryptData } from "cloud-config";
+
+console.log("test-config.ts", decryptData("U2FsdG", "test"));

test/test-config.ts

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"],
+      "~/*": ["./public/*"]
+    },
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"],
+  "moduleResolution": ["node_modules", ".next", "node"]
+}