quiver-protobuf-typescript 1.0.0

package/addressbook_pb.ts

@@ -0,0 +1,246 @@
+// Copyright 2021-2023 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v1.2.0 with parameter "target=ts"
+// @generated from file addressbook.proto (package example, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type {
+  BinaryReadOptions,
+  FieldList,
+  JsonReadOptions,
+  JsonValue,
+  PartialMessage,
+  PlainMessage,
+} from "@bufbuild/protobuf";
+import { Message, proto3, Timestamp } from "@bufbuild/protobuf";
+
+/**
+ * @generated from message example.Person
+ */
+export class Person extends Message<Person> {
+  /**
+   * @generated from field: string name = 1;
+   */
+  name = "";
+
+  /**
+   * Unique ID number for this person.
+   *
+   * @generated from field: int32 id = 2;
+   */
+  id = 0;
+
+  /**
+   * @generated from field: string email = 3;
+   */
+  email = "";
+
+  /**
+   * @generated from field: repeated example.Person.PhoneNumber phones = 4;
+   */
+  phones: Person_PhoneNumber[] = [];
+
+  /**
+   * @generated from field: google.protobuf.Timestamp last_updated = 5;
+   */
+  lastUpdated?: Timestamp;
+
+  constructor(data?: PartialMessage<Person>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "example.Person";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "id", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+    { no: 3, name: "email", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    {
+      no: 4,
+      name: "phones",
+      kind: "message",
+      T: Person_PhoneNumber,
+      repeated: true,
+    },
+    { no: 5, name: "last_updated", kind: "message", T: Timestamp },
+  ]);
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>
+  ): Person {
+    return new Person().fromBinary(bytes, options);
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>
+  ): Person {
+    return new Person().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>
+  ): Person {
+    return new Person().fromJsonString(jsonString, options);
+  }
+
+  static equals(
+    a: Person | PlainMessage<Person> | undefined,
+    b: Person | PlainMessage<Person> | undefined
+  ): boolean {
+    return proto3.util.equals(Person, a, b);
+  }
+}
+
+/**
+ * @generated from enum example.Person.PhoneType
+ */
+export enum Person_PhoneType {
+  /**
+   * @generated from enum value: MOBILE = 0;
+   */
+  MOBILE = 0,
+
+  /**
+   * @generated from enum value: HOME = 1;
+   */
+  HOME = 1,
+
+  /**
+   * @generated from enum value: WORK = 2;
+   */
+  WORK = 2,
+}
+// Retrieve enum metadata with: proto3.getEnumType(Person_PhoneType)
+proto3.util.setEnumType(Person_PhoneType, "example.Person.PhoneType", [
+  { no: 0, name: "MOBILE" },
+  { no: 1, name: "HOME" },
+  { no: 2, name: "WORK" },
+]);
+
+/**
+ * @generated from message example.Person.PhoneNumber
+ */
+export class Person_PhoneNumber extends Message<Person_PhoneNumber> {
+  /**
+   * @generated from field: string number = 1;
+   */
+  number = "";
+
+  /**
+   * @generated from field: example.Person.PhoneType type = 2;
+   */
+  type = Person_PhoneType.MOBILE;
+
+  constructor(data?: PartialMessage<Person_PhoneNumber>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "example.Person.PhoneNumber";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "number", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    {
+      no: 2,
+      name: "type",
+      kind: "enum",
+      T: proto3.getEnumType(Person_PhoneType),
+    },
+  ]);
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>
+  ): Person_PhoneNumber {
+    return new Person_PhoneNumber().fromBinary(bytes, options);
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>
+  ): Person_PhoneNumber {
+    return new Person_PhoneNumber().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>
+  ): Person_PhoneNumber {
+    return new Person_PhoneNumber().fromJsonString(jsonString, options);
+  }
+
+  static equals(
+    a: Person_PhoneNumber | PlainMessage<Person_PhoneNumber> | undefined,
+    b: Person_PhoneNumber | PlainMessage<Person_PhoneNumber> | undefined
+  ): boolean {
+    return proto3.util.equals(Person_PhoneNumber, a, b);
+  }
+}
+
+/**
+ * Our address book file is just one of these.
+ *
+ * @generated from message example.AddressBook
+ */
+export class AddressBook extends Message<AddressBook> {
+  /**
+   * @generated from field: repeated example.Person people = 1;
+   */
+  people: Person[] = [];
+
+  constructor(data?: PartialMessage<AddressBook>) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+
+  static readonly runtime: typeof proto3 = proto3;
+  static readonly typeName = "example.AddressBook";
+  static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 1, name: "people", kind: "message", T: Person, repeated: true },
+  ]);
+
+  static fromBinary(
+    bytes: Uint8Array,
+    options?: Partial<BinaryReadOptions>
+  ): AddressBook {
+    return new AddressBook().fromBinary(bytes, options);
+  }
+
+  static fromJson(
+    jsonValue: JsonValue,
+    options?: Partial<JsonReadOptions>
+  ): AddressBook {
+    return new AddressBook().fromJson(jsonValue, options);
+  }
+
+  static fromJsonString(
+    jsonString: string,
+    options?: Partial<JsonReadOptions>
+  ): AddressBook {
+    return new AddressBook().fromJsonString(jsonString, options);
+  }
+
+  static equals(
+    a: AddressBook | PlainMessage<AddressBook> | undefined,
+    b: AddressBook | PlainMessage<AddressBook> | undefined
+  ): boolean {
+    return proto3.util.equals(AddressBook, a, b);
+  }
+}

package/index.ts

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

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "quiver-protobuf-typescript",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@bufbuild/protobuf": "1.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.15.11",
+    "typescript": "4.7.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,63 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "lib": [
+      "es2017",
+      "es7",
+      "es6",
+      "dom"
+    ] /* 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. */,
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "dist" /* Redirect output structure to the directory. */,
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "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. */
+    // "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. */
+
+    /* 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. */
+  },
+  "exclude": ["node_modules", "dist", "test"]
+}