Skip to content
This repository has been archived by the owner on Jun 21, 2020. It is now read-only.

Commit

Permalink
Created bxpb-runtime package.
Browse files Browse the repository at this point in the history
Refs #1.

Generated the package with:

```
$ npm run lerna create bxpb-runtime

> root@ lerna /home/dparker/Source/bxpb
> lerna "create" "bxpb-runtime"

lerna notice cli v3.20.2
package name: (bxpb-runtime)
version: (0.0.0)
description: Runtime library for browser extension protocol buffers.
keywords: browser-extension browser-extensions chrome-extension chrome-extensions protocol-buffers library service services
homepage: https://github.com/dgp1130/bxpb/packages/bxpb-runtime/
license: (ISC) MIT
entry point: (lib/bxpb-runtime.js)
git repository: (https://github.com/dgp1130/bxpb)
```

Additional edits were deleting the generated JavaScript code and dropping the `main`, `files`, and `directories` keys in the `package.json` file. I'll re-add those as they become relevant. I also filled in the README with expected usage details.
  • Loading branch information
dgp1130 committed May 1, 2020
1 parent b46a1aa commit 5c43749
Show file tree
Hide file tree
Showing 12 changed files with 282 additions and 1 deletion.
11 changes: 11 additions & 0 deletions examples/simple/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# `simple`

> TODO: description
## Usage

```
const simple = require('simple');
// TODO: DEMONSTRATE API
```
13 changes: 13 additions & 0 deletions examples/simple/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions examples/simple/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "bxpb-ex-simple",
"version": "0.0.0",
"private": true,
"author": "Doug Parker <[email protected]>",
"homepage": "https://github.com/dgp1130/bxpb#readme",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/dgp1130/bxpb.git"
},
"scripts": {
"build": "tsc",
"test": "echo \"Error: run tests from root\" && exit 1"
},
"bugs": {
"url": "https://github.com/dgp1130/bxpb/issues"
},
"dependencies": {
"bxpb-runtime": "^0.0.0",
"typescript": "^3.8.3"
}
}
4 changes: 4 additions & 0 deletions examples/simple/src/example.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// TODO: How to import from `bxpb-runtime/client`?
import { foo } from 'bxpb-runtime/dist/test';

console.log(foo('Dave'));
66 changes: 66 additions & 0 deletions examples/simple/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es2019", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
"declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist/", /* Redirect output structure to the directory. */
"rootDir": "./src/", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}
3 changes: 2 additions & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"packages": [
"packages/*"
"packages/*",
"examples/*"
],
"version": "0.0.0"
}
48 changes: 48 additions & 0 deletions packages/bxpb-runtime/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# `bxpb-runtime`

Implements the runtime for clients and services using `bxpb`.

## Usage

Services should use `serve()` to listen to a message passing API and run a service on it.

```typescript
import { serve } from 'bxpb-runtime/service';
import { GreeterService } from 'protos/greeter_bx';
import { HelloRequest, HelloResponse } from 'protos/greeter_pb';

serve(chrome.runtime.onMessage, MyProtoService, {
// Implement methods of the service.
async greet(req: HelloRequest): Promise<HelloResponse> {
const res = new HelloResponse();
res.setMessage(`Hello, ${req.getName()}!`);
return res;
},
});
```

Clients should extend `ProtoClient` for a given service they want to call.

```typescript
import { ProtoClient } from 'bxpb-runtime/client';
import { GreeterService } from 'protos/greeter_bx';
import { HelloRequest, HelloResponse } from 'protos/greeter_pb';

class GreeterClient extends ProtoClient {
async greet(req: HelloRequest): Promise<HelloResponse> {
return await this.makeRpc(GreeterService, GreeterService.methods.greet, req);
}
}

(async () => {
const req = new HelloRequest();
req.setName('Dave');

const client = new GreeterClient(chrome.runtime.sendMessage);
const res = await client.greet(req);

console.log(res.getMessage()); // 'Hello, Dave!'
})();
```

Client classes are typically generated by `bxpb-protoc-plugin` and not hand-written.
13 changes: 13 additions & 0 deletions packages/bxpb-runtime/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions packages/bxpb-runtime/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "bxpb-runtime",
"version": "0.0.0",
"description": "Runtime library for browser extension protocol buffers.",
"keywords": [
"browser-extension",
"browser-extensions",
"chrome-extension",
"chrome-extensions",
"protocol-buffers",
"library",
"service",
"services"
],
"author": "Doug Parker <[email protected]>",
"homepage": "https://github.com/dgp1130/bxpb/packages/bxpb-runtime/",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/dgp1130/bxpb.git"
},
"scripts": {
"build": "tsc",
"test": "echo \"Error: run tests from root\" && exit 1"
},
"bugs": {
"url": "https://github.com/dgp1130/bxpb/issues"
},
"dependencies": {
"typescript": "^3.8.3"
}
}
1 change: 1 addition & 0 deletions packages/bxpb-runtime/src/client.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './test';
3 changes: 3 additions & 0 deletions packages/bxpb-runtime/src/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export function foo(name: string): string {
return `Hello, ${name}!`;
}
66 changes: 66 additions & 0 deletions packages/bxpb-runtime/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es2019", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "es2015", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
"declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist/", /* Redirect output structure to the directory. */
"rootDir": "./src/", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}

0 comments on commit 5c43749

Please sign in to comment.