From 16dc9feb3c686e163048858393f425d9e410ba1e Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Tue, 4 Mar 2025 11:48:03 -0500 Subject: [PATCH] sorta working, mostly not (#893) --- sdk/nodejs1/examples/pastebin/.gitignore | 2 + .../examples/pastebin/package-lock.json | 97 +++++++++++++++ sdk/nodejs1/examples/pastebin/package.json | 19 +++ sdk/nodejs1/examples/pastebin/src/index.ts | 40 +++++++ sdk/nodejs1/examples/pastebin/tsconfig.json | 110 ++++++++++++++++++ sdk/nodejs1/sdk/src/index.ts | 3 +- sdk/nodejs1/sdk/src/zrok/express.ts | 4 - sdk/nodejs1/sdk/src/zrok/share.ts | 1 + sdk/nodejs1/sdk/src/zrok/ziti.ts | 31 +++++ 9 files changed, 302 insertions(+), 5 deletions(-) create mode 100644 sdk/nodejs1/examples/pastebin/.gitignore create mode 100644 sdk/nodejs1/examples/pastebin/package-lock.json create mode 100644 sdk/nodejs1/examples/pastebin/package.json create mode 100644 sdk/nodejs1/examples/pastebin/src/index.ts create mode 100644 sdk/nodejs1/examples/pastebin/tsconfig.json create mode 100644 sdk/nodejs1/sdk/src/zrok/ziti.ts diff --git a/sdk/nodejs1/examples/pastebin/.gitignore b/sdk/nodejs1/examples/pastebin/.gitignore new file mode 100644 index 00000000..f06235c4 --- /dev/null +++ b/sdk/nodejs1/examples/pastebin/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist diff --git a/sdk/nodejs1/examples/pastebin/package-lock.json b/sdk/nodejs1/examples/pastebin/package-lock.json new file mode 100644 index 00000000..51288ba4 --- /dev/null +++ b/sdk/nodejs1/examples/pastebin/package-lock.json @@ -0,0 +1,97 @@ +{ + "name": "pastebin", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "pastebin", + "version": "1.0.0", + "dependencies": { + "@openziti/zrok": "file:../../sdk", + "commander": "^13.1.0", + "readline-sync": "^1.4.10", + "typescript": "^5.8.2" + }, + "devDependencies": { + "@types/node": "^22.13.9", + "@types/readline-sync": "^1.4.8" + } + }, + "../../sdk": { + "name": "@openziti/zrok", + "version": "1.0.0", + "license": "Apache-2.0", + "dependencies": { + "@openziti/ziti-sdk-nodejs": "^0.19.0", + "express": "^4.21.2" + }, + "devDependencies": { + "@types/express": "^5.0.0", + "@types/node": "^22.13.5", + "tsup": "^8.4.0", + "typescript": "^5.7.3", + "vitest": "^3.0.7" + } + }, + "node_modules/@openziti/zrok": { + "resolved": "../../sdk", + "link": true + }, + "node_modules/@types/node": { + "version": "22.13.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.13.9.tgz", + "integrity": "sha512-acBjXdRJ3A6Pb3tqnw9HZmyR3Fiol3aGxRCK1x3d+6CDAMjl7I649wpSd+yNURCjbOUGu9tqtLKnTGxmK6CyGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.20.0" + } + }, + "node_modules/@types/readline-sync": { + "version": "1.4.8", + "resolved": "https://registry.npmjs.org/@types/readline-sync/-/readline-sync-1.4.8.tgz", + "integrity": "sha512-BL7xOf0yKLA6baAX6MMOnYkoflUyj/c7y3pqMRfU0va7XlwHAOTOIo4x55P/qLfMsuaYdJJKubToLqRVmRtRZA==", + "dev": true, + "license": "MIT" + }, + "node_modules/commander": { + "version": "13.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-13.1.0.tgz", + "integrity": "sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/readline-sync": { + "version": "1.4.10", + "resolved": "https://registry.npmjs.org/readline-sync/-/readline-sync-1.4.10.tgz", + "integrity": "sha512-gNva8/6UAe8QYepIQH/jQ2qn91Qj0B9sYjMBBs3QOB8F2CXcKgLxQaJRP76sWVRQt+QU+8fAkCbCvjjMFu7Ycw==", + "license": "MIT", + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/typescript": { + "version": "5.8.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.2.tgz", + "integrity": "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ==", + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "6.20.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz", + "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==", + "dev": true, + "license": "MIT" + } + } +} diff --git a/sdk/nodejs1/examples/pastebin/package.json b/sdk/nodejs1/examples/pastebin/package.json new file mode 100644 index 00000000..abf733f3 --- /dev/null +++ b/sdk/nodejs1/examples/pastebin/package.json @@ -0,0 +1,19 @@ +{ + "name": "pastebin", + "version": "1.0.0", + "description": "A small example using the zrok network to securely transmit and receive data", + "main": "dist/index.js", + "scripts": { + "build": "tsc --build" + }, + "dependencies": { + "@openziti/zrok": "file:../../sdk", + "commander": "^13.1.0", + "readline-sync": "^1.4.10", + "typescript": "^5.8.2" + }, + "devDependencies": { + "@types/node": "^22.13.9", + "@types/readline-sync": "^1.4.8" + } +} diff --git a/sdk/nodejs1/examples/pastebin/src/index.ts b/sdk/nodejs1/examples/pastebin/src/index.ts new file mode 100644 index 00000000..1122142d --- /dev/null +++ b/sdk/nodejs1/examples/pastebin/src/index.ts @@ -0,0 +1,40 @@ +import {Command} from "commander"; +// @ts-ignore +import { + createShare, + deleteShare, + init, + listener, + loadRoot, + PRIVATE_SHARE_MODE, setLogLevel, + ShareRequest, + TCP_TUNNEL_BACKEND_MODE, + write +} from "@openziti/zrok"; +import readlineSync = require('readline-sync'); + +const program = new Command(); + +const copyto = async () => { + let text = readlineSync.question("enter some text: "); + let root = loadRoot(); + await init(root) + .catch((err: Error) => { + console.log(err); + return process.exit(1); + }); + let shr = await createShare(root, new ShareRequest(PRIVATE_SHARE_MODE, TCP_TUNNEL_BACKEND_MODE, "copyto")); + console.log("connect with 'copyto " + shr.shareToken + "'"); + listener(shr, {clientConnectCallback: (data: any) => { + console.log("data", data); + write(data.client, text) ; + }}); + + process.on("SIGINT", async () => { + console.log("cleaning up"); + deleteShare(root, shr); + }); +} + +program.command("copyto").version("1.0.0").description("serve a copy buffer").action(copyto); +program.parse(process.argv); \ No newline at end of file diff --git a/sdk/nodejs1/examples/pastebin/tsconfig.json b/sdk/nodejs1/examples/pastebin/tsconfig.json new file mode 100644 index 00000000..ae720c71 --- /dev/null +++ b/sdk/nodejs1/examples/pastebin/tsconfig.json @@ -0,0 +1,110 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + "types": ["node"], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": ["src/**/*"], +} diff --git a/sdk/nodejs1/sdk/src/index.ts b/sdk/nodejs1/sdk/src/index.ts index 086c2b0c..ae36fb54 100644 --- a/sdk/nodejs1/sdk/src/index.ts +++ b/sdk/nodejs1/sdk/src/index.ts @@ -1,3 +1,4 @@ export * from "./zrok/environment"; export * from "./zrok/express"; -export * from "./zrok/share"; \ No newline at end of file +export * from "./zrok/share"; +export * from "./zrok/ziti"; \ No newline at end of file diff --git a/sdk/nodejs1/sdk/src/zrok/express.ts b/sdk/nodejs1/sdk/src/zrok/express.ts index 7bebdcb5..5e2c879b 100644 --- a/sdk/nodejs1/sdk/src/zrok/express.ts +++ b/sdk/nodejs1/sdk/src/zrok/express.ts @@ -2,12 +2,8 @@ import {Share} from "../api"; import Express from "express"; // @ts-ignore import ziti from "@openziti/ziti-sdk-nodejs"; -import {Root} from "./environment"; export const express = (share: Share): Express.Application => { return ziti.express(Express, share.shareToken); } -export const init = (root: Root): Promise => { - return ziti.init(root.zitiIdentityName(root.environmentIdentityName())) -} \ No newline at end of file diff --git a/sdk/nodejs1/sdk/src/zrok/share.ts b/sdk/nodejs1/sdk/src/zrok/share.ts index 78085679..35fdd041 100644 --- a/sdk/nodejs1/sdk/src/zrok/share.ts +++ b/sdk/nodejs1/sdk/src/zrok/share.ts @@ -105,6 +105,7 @@ const toPrivateApiShareRequest = (root: Root, request: ShareRequest): ApiShareRe shareMode: ShareRequestShareModeEnum.Private, backendMode: toApiBackendMode(request.backendMode), backendProxyEndpoint: request.target, + authScheme: "none", }; } diff --git a/sdk/nodejs1/sdk/src/zrok/ziti.ts b/sdk/nodejs1/sdk/src/zrok/ziti.ts new file mode 100644 index 00000000..1971b8be --- /dev/null +++ b/sdk/nodejs1/sdk/src/zrok/ziti.ts @@ -0,0 +1,31 @@ +import {Root} from "./environment"; +// @ts-ignore +import ziti from "@openziti/ziti-sdk-nodejs"; +import {Share} from "../api"; + +export const init = (root: Root): Promise => { + return ziti.init(root.zitiIdentityName(root.environmentIdentityName())) +} + +export const setLogLevel = (level: number) => { + ziti.setLogLevel(level); +} + +export const listener = (shr: Share, + callbacks?: { + listenCallback?: any, + listenClientCallback?: any, + clientConnectCallback: any, + clientDataCallback?: any + }): ziti.listener => { + let listenCallback = callbacks?.listenCallback ? callbacks.listenClientCallback : (data: any) => {}; + let listenClientCallback = callbacks?.listenClientCallback ? callbacks.listenClientCallback : (data: any) => {}; + let clientConnectCallback = callbacks?.clientConnectCallback ? callbacks.clientConnectCallback : (data: any) => {}; + let clientDataCallback = callbacks?.clientDataCallback ? callbacks.clientDataCallback : (data: any) => {}; + console.log("client connect callback", clientConnectCallback); + ziti.listen(shr.shareToken, 0, listenCallback, listenClientCallback, clientConnectCallback, clientDataCallback); +} + +export const write = (conn: any, buf: any, writeCallback: any = () => {}) => { + ziti.write(conn, buf, writeCallback); +} \ No newline at end of file