chore: remove sys-node package & add readmes

Author: dOrgJelli

packages/client/src/__tests__/core/error-structure.spec.ts

@@ -10,7 +10,7 @@ import { msgpackDecode, msgpackEncode } from "@polywrap/msgpack-js";
 import {
   ClientConfigBuilder,
 } from "@polywrap/client-config-builder-js";
-import * as SysNodeBundle from "@polywrap/sys-node-config-bundle-js";
+import * as SysBundle from "@polywrap/sys-config-bundle-js";
 
 jest.setTimeout(660000);
 
@@ -415,7 +415,7 @@ describe("Error structure", () => {
       test("Invoke a plugin wrapper with malformed args", async () => {
         const client = await createClient();
         const result = await client.invoke<Uint8Array>({
-          uri: SysNodeBundle.bundle.fileSystem.uri,
+          uri: SysBundle.bundle.fileSystem.uri,
           method: "readFile",
           args: {
             pathh: "packages/client/src/__tests__/core/index.ts",
@@ -432,7 +432,7 @@ describe("Error structure", () => {
         expect(result.error?.reason).toEqual(
           'The "path" argument must be of type string or an instance of Buffer or URL. Received undefined'
         );
-        expect(result.error?.uri).toEqual(Uri.from(SysNodeBundle.bundle.fileSystem.uri).uri);
+        expect(result.error?.uri).toEqual(Uri.from(SysBundle.bundle.fileSystem.uri).uri);
         expect(result.error?.method).toEqual("readFile");
         expect(result.error?.args).toContain(
           '{\n  "pathh": "packages/client/src/__tests__/core/index.ts"\n}'
@@ -445,7 +445,7 @@ describe("Error structure", () => {
       test("Invoke a plugin wrapper with a method that doesn't exist", async () => {
         const client = await createClient();
         const result = await client.invoke<Uint8Array>({
-          uri: SysNodeBundle.bundle.fileSystem.uri,
+          uri: SysBundle.bundle.fileSystem.uri,
           method: "readFileNotFound",
           args: {
             path: __dirname + "/index.ts",
@@ -462,7 +462,7 @@ describe("Error structure", () => {
         expect(
           result.error?.reason.startsWith("Plugin missing method ")
         ).toBeTruthy();
-        expect(result.error?.uri).toEqual(Uri.from(SysNodeBundle.bundle.fileSystem.uri).uri);
+        expect(result.error?.uri).toEqual(Uri.from(SysBundle.bundle.fileSystem.uri).uri);
         expect(result.error?.method).toEqual("readFileNotFound");
       });
 
@@ -494,7 +494,7 @@ describe("Error structure", () => {
       test("Invoke a plugin wrapper that throws unexpectedly", async () => {
         const client = await createClient();
         const result = await client.invoke<Uint8Array>({
-          uri: SysNodeBundle.bundle.fileSystem.uri,
+          uri: SysBundle.bundle.fileSystem.uri,
           method: "readFile",
           args: {
             path: "./this/path/does/not/exist.ts",
@@ -511,7 +511,7 @@ describe("Error structure", () => {
         expect(
           result.error?.reason.startsWith("ENOENT: no such file or directory")
         ).toBeTruthy();
-        expect(result.error?.uri).toEqual(Uri.from(SysNodeBundle.bundle.fileSystem.uri).uri);
+        expect(result.error?.uri).toEqual(Uri.from(SysBundle.bundle.fileSystem.uri).uri);
         expect(result.error?.method).toEqual("readFile");
         expect(result.error?.args).toEqual(
           '{\n  "path": "./this/path/does/not/exist.ts"\n}'

packages/config-builder/README.md

@@ -69,7 +69,7 @@ Finally, build a ClientConfig or CoreClientConfig to pass to the PolywrapClient
 
 A complete example using all or most of the available methods.
 
-```typescript=
+```typescript
   // init
   const builder = new ClientConfigBuilder();
 

packages/config-builder/readme/README.md

@@ -40,7 +40,7 @@ $snippet: quickstart-build
 
 A complete example using all or most of the available methods.
 
-```typescript=
+```typescript
 $snippet: quickstart-example
 ```
 

packages/config-bundles/sys-node/package.json

@@ -0,0 +1,76 @@
+# Sys Config Bundle
+
+A collection of system-level configurations.
+
+## Bundle
+
+```typescript
+import { loggerPlugin } from "@polywrap/logger-plugin-js";
+import { dateTimePlugin } from "@polywrap/datetime-plugin-js";
+import { concurrentPromisePlugin } from "@polywrap/concurrent-plugin-js";
+import { httpPlugin } from "@polywrap/http-plugin-js";
+import * as httpResolver from "./embeds/http-resolver/wrap";
+
+export const bundle: Bundle = {
+  logger: {
+    uri: "plugin/logger@1.0.0",
+    package: loggerPlugin({}),
+    implements: ["ens/wraps.eth:logger@1.0.0"],
+    redirectFrom: ["ens/wraps.eth:logger@1.0.0"],
+  },
+  datetime: {
+    uri: "plugin/datetime@1.0.0",
+    package: dateTimePlugin({}),
+    implements: ["ens/wraps.eth:datetime@1.0.0"],
+    redirectFrom: ["ens/wraps.eth:datetime@1.0.0"],
+  },
+  concurrent: {
+    uri: "plugin/concurrent@1.0.0",
+    package: concurrentPromisePlugin({}),
+    implements: ["ens/wraps.eth:concurrent@1.0.0"],
+    redirectFrom: ["ens/wraps.eth:concurrent@1.0.0"],
+  },
+  http: {
+    uri: "plugin/http@1.1.0",
+    package: httpPlugin({}),
+    implements: ["ens/wraps.eth:http@1.1.0", "ens/wraps.eth:http@1.0.0"],
+    redirectFrom: ["ens/wraps.eth:http@1.1.0", "ens/wraps.eth:http@1.0.0"],
+  },
+  httpResolver: {
+    uri: "embed/http-uri-resolver-ext@1.0.1",
+    package: httpResolver.wasmPackage,
+    implements: [
+      "ens/wraps.eth:http-uri-resolver-ext@1.0.1",
+      ExtendableUriResolver.defaultExtInterfaceUris[0].uri,
+    ],
+    redirectFrom: ["ens/wraps.eth:http-uri-resolver-ext@1.0.1"],
+  },
+};
+```
+
+### Node.JS
+
+If you're using this package within Node.JS, you'll also have the following configurations:
+```typescript
+import { fileSystemPlugin } from "@polywrap/file-system-plugin-js";
+import * as fileSystemResolver from "./embeds/file-system-resolver/wrap";
+
+export const bundle: Bundle = {
+  ...Common.bundle,
+  fileSystem: {
+    uri: "plugin/file-system@1.0.0",
+    package: fileSystemPlugin({}),
+    implements: ["ens/wraps.eth:file-system@1.0.0"],
+    redirectFrom: ["ens/wraps.eth:file-system@1.0.0"],
+  },
+  fileSystemResolver: {
+    uri: "embed/file-system-uri-resolver-ext@1.0.1",
+    package: fileSystemResolver.wasmPackage,
+    implements: [
+      "ens/wraps.eth:file-system-uri-resolver-ext@1.0.1",
+      ExtendableUriResolver.defaultExtInterfaceUris[0].uri,
+    ],
+    redirectFrom: ["ens/wraps.eth:file-system-uri-resolver-ext@1.0.1"],
+  },
+};
+```

packages/config-bundles/sys-node/scripts/embed-wraps.ts

@@ -13,23 +13,49 @@
   ],
   "scripts": {
     "build": "rimraf ./build && tsc",
+    "build:docs": "yarn doc-snippets combine",
     "lint": "eslint --color -c ../../../.eslintrc.js src/"
   },
   "dependencies": {
     "@polywrap/config-bundle-types-js": "~0.10.1",
     "@polywrap/concurrent-plugin-js": "~0.10.0",
     "@polywrap/datetime-plugin-js": "~0.10.0",
+    "@polywrap/file-system-plugin-js": "~0.10.0",
     "@polywrap/http-plugin-js": "~0.10.0",
     "@polywrap/logger-plugin-js": "~0.10.0",
-    "@polywrap/sys-node-config-bundle-js": "~0.10.1",
     "@polywrap/uri-resolver-extensions-js": "~0.10.1",
     "base64-to-uint8array": "1.0.0"
   },
   "devDependencies": {
+    "doc-snippets": "~1.0.0",
     "rimraf": "3.0.2",
     "typescript": "4.9.5"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "doc-snippets": {
+    "extract": {
+      "include": ["./src/**/*.{ts,tsx,json,yaml,txt,md,graphql,cue}"],
+      "ignore": [
+        "./**/node_modules/**",
+        "./**/.polywrap/**",
+        "./**/__tests__/**"
+      ],
+      "dir": "./"
+    },
+    "inject": {
+      "dir": "./readme",
+      "include": "./README.md"
+    },
+    "startTokens": [
+      { "pattern": "$start: ", "inline": false },
+      { "pattern": "/* $: {SNIPPET_NAME} */", "inline": true }
+    ],
+    "endTokens": [
+      { "pattern": "$end", "inline": false },
+      { "pattern": "/* $ */", "inline": true }
+    ],
+    "outputDir": "./"
   }
 }