@vonage/client-sdk 1.3.0-alpha.1 → 1.3.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonage/client-sdk",
-  "version": "1.3.0-alpha.1",
+  "version": "1.3.0-alpha.3",
   "description": "",
   "type": "module",
   "module": "dist/client/index.mjs",
@@ -31,7 +31,9 @@
     "check": "tsc --project ./examples/tsconfig.json --noEmit --skipLibCheck --strictNullChecks true",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "clean": "rm -Rf node_modules/*; rm -Rf dist/"
+    "clean": "rm -Rf node_modules/*; rm -Rf dist/",
+    "build:docs": "npx typedoc --includeVersion --tsconfig ./tsconfig.json --out api_docs/ts src/client/index.ts --includes examples/snippets --disableSources --excludeReferences",
+    "clean:doNotUseOrImplementIt": "node ./scripts/replaceAllDoNotUseOrImplement.js ./src/kotlin/clientsdk-clientcore_js.d.ts && node ./scripts/replaceAllDoNotUseOrImplement.js ./dist/kotlin/clientsdk-clientcore_js.d.ts"
   },
   "author": "Vonage CS Team <nexmo.rtc.ci@vonage.com> (https://developer.vonage.com/client-sdk/overview)",
   "license": "SEE LICENSE IN LICENSE",

package/scripts/replaceAllDoNotUseOrImplement.js

@@ -0,0 +1,25 @@
+import { readFileSync, writeFileSync } from 'fs';
+
+function replaceAllDoNotUseOrImplement(filePath) {
+  const oldLines = readFileSync(filePath, 'utf8').split('\n');
+  const newLines = [];
+
+  let toSkip = false;
+
+  for (let line of oldLines) {
+    if (line.includes('__doNotUseOrImplementIt')) {
+      toSkip = !line.includes(';');
+      continue;
+    } else if (toSkip) {
+      toSkip = !line.includes('};');
+      continue;
+    }
+
+    newLines.push(line);
+  }
+
+  writeFileSync(filePath, newLines.join('\n'), 'utf8');
+}
+
+const filePath = process.argv[2];
+replaceAllDoNotUseOrImplement(filePath);

package/typedoc.json

@@ -0,0 +1,40 @@
+{
+  "disableSources": true,
+  "hideGenerator": true,
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true
+  },
+  "categorizeByGroup": true,
+  "visibilityFilters": {
+    "protected": false,
+    "private": false,
+    "inherited": true,
+    "external": true,
+    "@alpha": false,
+    "@beta": false
+  },
+  "excludeReferences": true,
+  "excludeNotDocumented": true,
+  "excludeNotDocumentedKinds": [
+    "Module",
+    "Namespace",
+    "Enum",
+    // "EnumMember",
+    "Variable",
+    "Function",
+    // "Class",
+    // "Interface",
+    // "Constructor",
+    // "Property",
+    "Method",
+    "CallSignature",
+    "IndexSignature",
+    "ConstructorSignature",
+    // "Accessor",
+    // "GetSignature",
+    // "SetSignature",
+    "TypeAlias",
+    "Reference"
+  ]
+}