Git Product home page Git Product logo

sdp-js's Introduction

sdp.js

JavaScript libraries for the SDP protocol.

Developing

Please make any changes in a feature branch and add a pull request. All changes should have relevant tests and documentation.

Testing

Tests can be run with pnpm run test or the VSCode Test task

Style

Code formatting/style can be validated using:

pnpm codequality:check

And fixed using:

pnpm codequality:fix

Releasing

The package is automatically released each time a tag is created, so to release just create a tag such as v1.23.6 and push that tag. This automatically triggers NPM publish etc.

sdp-js's People

Contributors

dylanratcliffe avatar renovate[bot] avatar getinnocuous avatar dependabot[bot] avatar davids-ovm avatar

Watchers

 avatar  avatar

sdp-js's Issues

Refactor progress tracking and errors

As part of this change: overmindtech/sdp#12 there have been a number of changes to the protocol, namely:

  • linkedItemSubject has been removed
  • Errors are now included as part of a response, and the errorSubject has been removed

This repo needs to be refactored to work with these new changes

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): update all non-major dependencies (pnpm, vite)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

devcontainer
.devcontainer/devcontainer.json
  • mcr.microsoft.com/devcontainers/typescript-node 1-20-bullseye
  • ghcr.io/devcontainers/features/node 1
  • ghcr.io/devcontainers-contrib/features/pnpm 2
github-actions
.github/workflows/ci.yaml
  • actions/checkout v4
  • actions/setup-node v4
  • actions/cache v4
.github/workflows/release.yaml
  • actions/checkout v4
  • actions/setup-node v4
  • ncipollo/release-action v1
.github/workflows/tests.yml
  • actions/checkout v4
  • actions/setup-node v4
  • actions/cache v4
npm
package.json
  • @bufbuild/protobuf ^1.10.0
  • @connectrpc/connect-query ^1.4.1
  • uuid ^10.0.0
  • @types/node ^20.14.15
  • @types/uuid ^10.0.0
  • @vitest/coverage-v8 ^2.0.5
  • @vitest/ui ^2.0.5
  • changelogen ^0.5.5
  • eslint ^9.9.0
  • eslint-config-prettier ^9.1.0
  • eslint-config-unjs ^0.3.2
  • jest-websocket-mock ^2.5.0
  • prettier ^3.3.3
  • typescript ^5.5.4
  • unbuild ^2.0.0
  • vite ^5.4.0
  • vitest ^2.0.5
  • pnpm 9.7.0

  • Check this box to trigger a request for Renovate to run again on this repository

Handle new types in SDP v0.18

SDP v0.18 adds a load of new types and API endpoints. We need to work out what changes need to be made before this can be used:

  • Get the tests passing
  • See what needs to be done for the frontend to start consuming this
  • Release

Rename subjects to singular

As part of overmindtech/sdp#12 subjects have been renamed to singular. This means that in this repo the following needs to be refactored:

  • requests.all changed to request.all
  • requests.contexts.{context} changed to request.context.{context}

Upgrade to SDP 0.12.1

I'm having issues with compiling the js code at the moment:

protoc-gen-js: program not found or is not executable
Please specify a program using absolute path or make sure the program is available in your PATH system variable

This is due to a bug in the latest release of protobuf: protocolbuffers/protobuf-javascript#127

Once this is fixed I need to:

  • Generate the new TS files
  • Create a method called Done() that tells if a request is fully complete, including post-processing

GetUniqueAttributeValue on non-strings are broken

When calling Util.GetUniqueAttributeValue() on an item that has a non-string UAV, we get strange output. For example when called against a process for which the UAV is in integer 1, we get: ",1"

Need to add some spec testing so that I can test for this sort of thing easily as we don't currently have that

Autocomplete

It will be good for the UI to be able to intelligently autocomplete as per this ticket: overmindtech/discovery#56

In order for this to be easy to implement in the front-end, we should create a wrapper that returns autocomplete suggestions for a given string.

Separate stuff into own files

I tried this initially and even though it passed all the tests I was getting an error at runtime:

"X is not a Constructor"

When trying to use the constructors of any of the objects from the different file, even though they were being imported and re-exported in the index.ts file. I looked at a few different ways to try and get it to export them correctly and the only way that I could get it to work was to have everything in the one file, which sucks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.