protons 2.0.1 → 3.0.0

package/package.json

@@ -1,82 +1,161 @@
 {
   "name": "protons",
-  "version": "2.0.1",
-  "description": "Protocol Buffers for Node.js without compiliation",
-  "leadMaintainer": "Alex Potsides <alex@achingbrain.net>",
+  "version": "3.0.0",
+  "description": "Protobuf to ts transpiler",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/protons/tree/master/packages/protons#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ipfs/protons"
+    "url": "git+https://github.com/ipfs/protons.git"
   },
-  "dependencies": {
-    "protocol-buffers-schema": "^3.3.1",
-    "signed-varint": "^2.0.1",
-    "uint8arrays": "^2.1.3",
-    "varint": "^5.0.0"
+  "bugs": {
+    "url": "https://github.com/ipfs/protons/issues"
   },
-  "devDependencies": {
-    "aegir": "^25.0.0",
-    "benchmark": "^2.1.4",
-    "protocol-buffers": "^4.1.0",
-    "protons": "^1.0.0",
-    "tape": "^4.8.0"
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "bin": {
+    "protons": "./dist/bin/protons.js"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js",
+      "types": "./dist/src/index.d.ts"
+    },
+    "./status": {
+      "import": "./dist/src/status.js",
+      "types": "./dist/src/status.d.ts"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
   },
   "scripts": {
-    "test": "aegir test",
-    "test:browser": "aegir test --target browser",
-    "test:node": "aegir test --target node",
     "lint": "aegir lint",
-    "release": "aegir release",
-    "release-minor": "aegir release --type minor",
-    "release-major": "aegir release --type major",
-    "build": "aegir build",
-    "bench": "node bench"
-  },
-  "bugs": {
-    "url": "https://github.com/ipfs/protons/issues"
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -t node -f ./dist/test/*.js -f ./dist/test/**/*.js",
+    "test:node": "npm run test -- -t node --cov",
+    "release": "semantic-release -e semantic-release-monorepo"
   },
-  "homepage": "https://github.com/ipfs/protons",
-  "main": "src/index.js",
-  "directories": {
-    "test": "test"
+  "dependencies": {
+    "meow": "^10.1.2",
+    "protobufjs": "^6.11.2"
   },
-  "keywords": [
-    "protobuf",
-    "protocol",
-    "buffers",
-    "protocolbuffers",
-    "encode",
-    "decode",
-    "google",
-    "serialize",
-    "parse",
-    "levelup",
-    "encodings",
-    "encoding"
-  ],
-  "author": "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
-  "license": "MIT",
-  "contributors": [
-    "Mathias Buus <mathiasbuus@gmail.com>",
-    "dignifiedquire <dignifiedquire@gmail.com>",
-    "achingbrain <alex@achingbrain.net>",
-    "Young Hahn <young@mapbox.com>",
-    "David Dias <daviddias.p@gmail.com>",
-    "Hector Sanjuan <code@hector.link>",
-    "Mo Kamioner <mkamioner@gmail.com>",
-    "tcme <hi@this-connect.me>",
-    "Eduardo Sorribas <eduardo@sorribas.org>",
-    "Hugo Dias <hugomrdias@gmail.com>",
-    "Lars-Magnus Skog <ralphtheninja@riseup.net>",
-    "Patrick Pfeiffer <patrick@buzzle.at>",
-    "Kevin Ennis <kennis84@gmail.com>",
-    "Elijah Insua <tmpvar@gmail.com>",
-    "Astro <astro@spaceboyz.net>",
-    "Andreas Madsen <amwebdk@gmail.com>",
-    "Sergii Shutovskyi <sergii.shutovskyi@trademob.com>",
-    "Steven Allen <steven@stebalien.com>",
-    "David Bruant <bruant.d@gmail.com>",
-    "Irakli Gozalishvili <contact@gozala.io>",
-    "João Antunes <j.goncalo.antunes@gmail.com>",
-    "Brendan Ward <bcward@consbio.org>"
-  ]
+  "devDependencies": {
+    "aegir": "^36.1.3",
+    "long": "^4.0.0",
+    "pbjs": "^0.0.14",
+    "protons-runtime": "^1.0.0"
+  }
 }

package/src/index.ts

@@ -0,0 +1,282 @@
+import { main as pbjs } from 'protobufjs/cli/pbjs.js'
+import path from 'path'
+import { promisify } from 'util'
+import fs from 'fs/promises'
+
+function pathWithExtension (input: string, extension: string) {
+  return path.join(path.dirname(input), path.basename(input).split('.').slice(0, -1).join('.') + extension)
+}
+
+const types: Record<string, string> = {
+  double: 'number',
+  float: 'number',
+  int32: 'number',
+  int64: 'bigint',
+  uint32: 'number',
+  uint64: 'bigint',
+  sint32: 'number',
+  sint64: 'bigint',
+  fixed32: 'number',
+  fixed64: 'bigint',
+  sfixed32: 'number',
+  sfixed64: 'bigint',
+  bool: 'boolean',
+  string: 'string',
+  bytes: 'Uint8Array'
+}
+
+function findTypeName (typeName: string, classDef: MessageDef, moduleDef: ModuleDef): string {
+  if (types[typeName] != null) {
+    return types[typeName]
+  }
+
+  if (isEnumDef(classDef)) {
+    throw new Error('Could not find type in enum')
+  }
+
+  if (classDef.nested?.[typeName] != null) {
+    return `${classDef.fullName}.${typeName}`
+  }
+
+  if (classDef.parent != null) {
+    return findTypeName(typeName, classDef.parent, moduleDef)
+  }
+
+  if (moduleDef.globals[typeName] != null) {
+    return typeName
+  }
+
+  throw new Error(`Could not resolve type name "${typeName}"`)
+}
+
+function findDef (typeName: string, classDef: MessageDef, moduleDef: ModuleDef): MessageDef {
+  if (isEnumDef(classDef)) {
+    throw new Error('Could not find type in enum')
+  }
+
+  if (classDef.nested?.[typeName] != null) {
+    return classDef.nested?.[typeName]
+  }
+
+  if (classDef.parent != null) {
+    return findDef(typeName, classDef.parent, moduleDef)
+  }
+
+  if (moduleDef.globals[typeName] != null) {
+    return moduleDef.globals[typeName]
+  }
+
+  throw new Error(`Could not resolve type name "${typeName}"`)
+}
+
+const encoders: Record<string, string> = {
+  bool: 'bool',
+  double: 'double',
+  bytes: 'bytes',
+  fixed32: 'fixed32',
+  fixed64: 'fixed64',
+  float: 'float',
+  int32: 'int32',
+  int64: 'int64',
+  sint32: 'sint32',
+  sint64: 'sint64',
+  string: 'string',
+  uint32: 'uint32',
+  uint64: 'uint64',
+  sfixed32: 'sfixed32',
+  sfixed64: 'sfixed64'
+}
+
+interface ClassDef {
+  name: string
+  fullName: string
+  parent?: ClassDef
+  fields?: Record<string, FieldDef>
+  nested?: Record<string, ClassDef>
+}
+
+interface EnumDef {
+  name: string
+  fullName: string
+  parent?: ClassDef
+  values: Record<string, number>
+}
+
+type MessageDef = ClassDef | EnumDef
+
+function isEnumDef (obj: any): obj is EnumDef {
+  return obj.values != null
+}
+
+interface FieldDef {
+  type: string
+  id: number
+  options?: Record<string, any>
+  rule: string
+}
+
+function defineFields (fields: Record<string, FieldDef>, messageDef: MessageDef, moduleDef: ModuleDef) {
+  return Object.entries(fields).map(([fieldName, fieldDef]) => {
+    const isArray = fieldDef.rule === 'repeated'
+    const isOptional = !isArray && fieldDef.options?.proto3_optional === true
+
+    return `${fieldName}${isOptional ? '?' : ''}: ${findTypeName(fieldDef.type, messageDef, moduleDef)}${isArray ? '[]' : ''}`
+  })
+}
+
+function compileMessage (messageDef: MessageDef, moduleDef: ModuleDef): string {
+  if (isEnumDef(messageDef)) {
+    moduleDef.imports.add('enumeration')
+
+    return `
+export enum ${messageDef.name} {
+  ${
+    Object.entries(messageDef.values).map(([enumValueName, enumValue]) => {
+      return `${enumValueName} = '${enumValueName}'`
+    }).join(',\n  ').trim()
+  }
+}
+
+export namespace ${messageDef.name} {
+  export const codec = enumeration<typeof ${messageDef.name}>(${messageDef.name})
+}
+`
+  }
+
+  let nested = ''
+
+  if (messageDef.nested != null) {
+    nested = '\n'
+    nested += Object.values(messageDef.nested)
+      .map(def => compileMessage(def, moduleDef).trim())
+      .join('\n')
+      .split('\n')
+      .map(line => line.trim() === '' ? '' : `  ${line}`)
+      .join('\n')
+    nested += '\n'
+  }
+
+  const fields = messageDef.fields ?? {}
+
+  // import relevant modules
+  moduleDef.imports.add('encodeMessage')
+  moduleDef.imports.add('decodeMessage')
+  moduleDef.imports.add('message')
+
+  return `
+export interface ${messageDef.name} {
+  ${
+    defineFields(fields, messageDef, moduleDef)
+      .join('\n  ')
+      .trim()
+  }
+}
+
+export namespace ${messageDef.name} {${nested}
+  export const codec = message<${messageDef.name}>({
+    ${Object.entries(fields)
+      .map(([name, fieldDef]) => {
+        let codec = encoders[fieldDef.type]
+
+        if (codec == null) {
+          const def = findDef(fieldDef.type, messageDef, moduleDef)
+
+          if (isEnumDef(def)) {
+            moduleDef.imports.add('enumeration')
+          } else {
+            moduleDef.imports.add('message')
+          }
+
+          const typeName = findTypeName(fieldDef.type, messageDef, moduleDef)
+          codec = `${typeName}.codec`
+        } else {
+          moduleDef.imports.add(codec)
+        }
+
+        return `${fieldDef.id}: { name: '${name}', codec: ${codec}${fieldDef.options?.proto3_optional === true ? ', optional: true' : ''}${fieldDef.rule === 'repeated' ? ', repeats: true' : ''} }`
+    }).join(',\n    ')}
+  })
+
+  export const encode = (obj: ${messageDef.name}): Uint8Array => {
+    return encodeMessage(obj, ${messageDef.name}.codec)
+  }
+
+  export const decode = (buf: Uint8Array): ${messageDef.name} => {
+    return decodeMessage(buf, ${messageDef.name}.codec)
+  }
+}
+`
+}
+
+interface ModuleDef {
+  imports: Set<string>
+  types: Set<string>
+  compiled: string[]
+  globals: Record<string, ClassDef>
+}
+
+function defineModule (def: ClassDef): ModuleDef {
+  const moduleDef: ModuleDef = {
+    imports: new Set(),
+    types: new Set(),
+    compiled: [],
+    globals: {}
+  }
+
+  const defs = def.nested
+
+  if (defs == null) {
+    throw new Error('No top-level messages found in protobuf')
+  }
+
+  function defineMessage (defs: Record<string, ClassDef>, parent?: ClassDef) {
+    for (const className of Object.keys(defs)) {
+      const classDef = defs[className]
+
+      classDef.name = className
+      classDef.parent = parent
+      classDef.fullName = parent == null ? className : `${parent.fullName}.${className}`
+
+      if (classDef.nested != null) {
+        defineMessage(classDef.nested, classDef)
+      }
+
+      if (parent == null) {
+        moduleDef.globals[className] = classDef
+      }
+    }
+  }
+
+  defineMessage(defs)
+
+  for (const className of Object.keys(defs)) {
+    const classDef = defs[className]
+
+    moduleDef.compiled.push(compileMessage(classDef, moduleDef))
+  }
+
+  return moduleDef
+}
+
+export async function generate (source: string, flags: any) {
+  // convert .protobuf to .json
+  const json = await promisify(pbjs)(['-t', 'json', source])
+
+  if (json == null) {
+    throw new Error(`Could not convert ${source} to intermediate JSON format`)
+  }
+
+  const def = JSON.parse(json)
+  const moduleDef = defineModule(def)
+
+  const content = `
+/* eslint-disable import/export */
+/* eslint-disable @typescript-eslint/no-namespace */
+
+import { ${Array.from(moduleDef.imports).join(', ')} } from 'protons-runtime'
+
+${moduleDef.compiled.map(str => str.trim()).join('\n\n').trim()}
+`.trim()
+
+  await fs.writeFile(pathWithExtension(source, '.ts'), content + '\n')
+}

package/.aegir.js

@@ -1,11 +0,0 @@
-'use strict'
-
-module.exports = {
-  webpack: {
-    node: {
-      // this is needed until protocol-buffers stops using node core APIs in browser code
-      os: true,
-      Buffer: true
-    }
-  }
-}

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +0,0 @@
-blank_issues_enabled: false
-contact_links:
- - name: Getting Help on IPFS
-   url: https://ipfs.io/help
-   about: All information about how and where to get help on IPFS.
- - name: IPFS Official Forum
-   url: https://discuss.ipfs.io
-   about: Please post general questions, support requests, and discussions here.

package/.github/ISSUE_TEMPLATE/open_an_issue.md

@@ -1,19 +0,0 @@
----
-name: Open an issue
-about: Only for actionable issues relevant to this repository.
-title: ''
-labels: need/triage
-assignees: ''
-
----
-<!--
-Hello! To ensure this issue is correctly addressed as soon as possible by the IPFS team, please try to make sure:
-
-- This issue is relevant to this repository's topic or codebase.
-
-- A clear description is provided. It should includes as much relevant information as possible and clear scope for the issue to be actionable.
-
-FOR GENERAL DISCUSSION, HELP OR QUESTIONS, please see the options at https://ipfs.io/help or head directly to https://discuss.ipfs.io.
-
-(you can delete this section after reading)
--->

package/.github/config.yml

@@ -1,68 +0,0 @@
-# Configuration for welcome - https://github.com/behaviorbot/welcome
-
-# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
-# Comment to be posted to on first time issues
-newIssueWelcomeComment: >
-  Thank you for submitting your first issue to this repository! A maintainer
-  will be here shortly to triage and review.
-
-  In the meantime, please double-check that you have provided all the
-  necessary information to make this process easy! Any information that can
-  help save additional round trips is useful! We currently aim to give
-  initial feedback within **two business days**. If this does not happen, feel
-  free to leave a comment.
-
-  Please keep an eye on how this issue will be labeled, as labels give an
-  overview of priorities, assignments and additional actions requested by the
-  maintainers:
-
-    - "Priority" labels will show how urgent this is for the team.
-    - "Status" labels will show if this is ready to be worked on, blocked, or in progress.
-    - "Need" labels will indicate if additional input or analysis is required.
-
-  Finally, remember to use https://discuss.ipfs.io if you just need general
-  support.
-
-# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
-# Comment to be posted to on PRs from first time contributors in your repository
-newPRWelcomeComment: >
-  Thank you for submitting this PR!
-
-  A maintainer will be here shortly to review it.
-
-  We are super grateful, but we are also overloaded! Help us by making sure
-  that:
-
-    * The context for this PR is clear, with relevant discussion, decisions
-      and stakeholders linked/mentioned.
-
-    * Your contribution itself is clear (code comments, self-review for the
-      rest) and in its best form. Follow the [code contribution
-      guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines)
-      if they apply.
-
-  Getting other community members to do a review would be great help too on
-  complex PRs (you can ask in the chats/forums). If you are unsure about
-  something, just leave us a comment.
-
-  Next steps:
-
-    * A maintainer will triage and assign priority to this PR, commenting on
-      any missing things and potentially assigning a reviewer for high
-      priority items.
-
-    * The PR gets reviews, discussed and approvals as needed.
-
-    * The PR is merged by maintainers when it has been approved and comments addressed.
-
-  We currently aim to provide initial feedback/triaging within **two business
-  days**. Please keep an eye on any labelling actions, as these will indicate
-  priorities and status of your contribution.
-
-  We are very grateful for your contribution!
-
-
-# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
-# Comment to be posted to on pull requests merged by a first time user
-# Currently disabled
-#firstPRMergeComment: ""

package/.travis.yml

@@ -1,42 +0,0 @@
-language: node_js
-cache: npm
-stages:
-  - check
-  - test
-  - cov
-
-node_js:
-  - '10'
-  - '12'
-  - '14'
-
-os:
-  - linux
-  - osx
-  - windows
-
-script: npx nyc -s npm run test:node -- --bail
-after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
-
-jobs:
-  include:
-    - stage: check
-      script:
-        - npx aegir commitlint --travis
-        - npx aegir dep-check
-        - npm run lint
-
-    - stage: test
-      name: chrome
-      addons:
-        chrome: stable
-      script: npx aegir test -t browser -t webworker
-
-    - stage: test
-      name: firefox
-      addons:
-        firefox: latest
-      script: npx aegir test -t browser -t webworker -- --browsers FirefoxHeadless
-
-notifications:
-  email: false