From f48034576b5153b8aa916c1d0845534a98f0b07c Mon Sep 17 00:00:00 2001 From: "Shah, Kevin" Date: Thu, 10 Oct 2024 13:11:12 -0400 Subject: [PATCH] fix: updated ripple to lifecycle-manager --- .github/workflows/release-github.yml | 4 ++-- .gitignore | 6 ++--- README.md | 4 ++-- package.json | 5 +++-- src/js/github.io/index.mjs | 2 +- src/js/version-specification/apis.mjs | 4 ++-- src/js/version.mjs | 2 +- src/json/firebolt-specification.json | 2 +- .../CHANGELOG.md | 0 .../CONTRIBUTING.md | 0 .../{ripple => lifecycle-manager}/LICENSE | 0 src/sdks/{ripple => lifecycle-manager}/NOTICE | 0 .../{ripple => lifecycle-manager}/README.md | 8 +++---- .../jest.config.json | 0 .../package.json | 22 +++++++++---------- .../sdk.config.json | 2 +- .../src/js/sdk/index.mjs | 0 .../test/suite/lifecyclemanagement.test.ts | 0 .../tsconfig.json | 0 src/template/openrpc/template.json | 2 +- 20 files changed, 32 insertions(+), 31 deletions(-) rename src/sdks/{ripple => lifecycle-manager}/CHANGELOG.md (100%) rename src/sdks/{ripple => lifecycle-manager}/CONTRIBUTING.md (100%) rename src/sdks/{ripple => lifecycle-manager}/LICENSE (100%) rename src/sdks/{ripple => lifecycle-manager}/NOTICE (100%) rename src/sdks/{ripple => lifecycle-manager}/README.md (74%) rename src/sdks/{ripple => lifecycle-manager}/jest.config.json (100%) rename src/sdks/{ripple => lifecycle-manager}/package.json (65%) rename src/sdks/{ripple => lifecycle-manager}/sdk.config.json (93%) rename src/sdks/{ripple => lifecycle-manager}/src/js/sdk/index.mjs (100%) rename src/sdks/{ripple => lifecycle-manager}/test/suite/lifecyclemanagement.test.ts (100%) rename src/sdks/{ripple => lifecycle-manager}/tsconfig.json (100%) diff --git a/.github/workflows/release-github.yml b/.github/workflows/release-github.yml index f6e2e61..1d4f7ca 100644 --- a/.github/workflows/release-github.yml +++ b/.github/workflows/release-github.yml @@ -92,7 +92,7 @@ jobs: with: script: | const fs = require('fs'); - const path = './src/sdks/ripple/dist/lib/ripple.mjs'; + const path = './src/sdks/lifecycle-manager/dist/lib/lifecycle-manager.mjs'; return fs.existsSync(path); - name: File Existence Output run: | @@ -126,7 +126,7 @@ jobs: # PRIVATE_KEY: ${{inputs.PRIVATE_KEY}} # run: | # cd /tmp - # git clone git@github.com:rdkcentral/ripple-doc.git ./firebolt-docs + # git clone git@github.com:rdkcentral/lifecycle-manager-doc.git ./firebolt-docs # - name: Release docs to GitHub.io # if: steps.check_build.outputs.result == 'true' && (github.ref_name == 'main' || github.ref_name == 'next' || github.ref_name == 'next-major' || github.event_name == 'pull_request') # env: diff --git a/.gitignore b/.gitignore index b8ca9ae..d5fdb01 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,8 @@ build/* dist/* -src/sdks/ripple/dist/* -src/sdks/ripple/build/* -src/sdks/ripple/test/transpiled-suite +src/sdks/lifecycle-manager/dist/* +src/sdks/lifecycle-manager/build/* +src/sdks/lifecycle-manager/test/transpiled-suite node_modules/* test/transpiled-suite .DS_Store diff --git a/README.md b/README.md index 90bb4bf..d177860 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ --- -title: Ripple RPC +title: Lifecycle Manager --- -Private Ripple RPC API for distributor integration. +Private Lifecycle Manager API for distributor integration. diff --git a/package.json b/package.json index 03f7a1d..14cd643 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { "name": "@firebolt-js/lifecycle-manager", "version": "1.1.0-next.1", - "description": "A Ripple specific RPC definition", + "description": "A lifecycle-manager specific RPC definition", "main": "./dist/lib/lifecycle-manager.mjs", "types": "./dist/lib/lifecycle-manager.d.ts", "type": "module", "workspaces": [ - "src/sdks/ripple" + "src/sdks/lifecycle-manager" ], "scripts": { "fs:setup": "npm run clean && mkdir -p dist", @@ -57,6 +57,7 @@ }, "keywords": [ "firebolt", + "lifecycle-manager", "ripple" ], "license": "Apache-2.0" diff --git a/src/js/github.io/index.mjs b/src/js/github.io/index.mjs index 8fd7432..25373fd 100644 --- a/src/js/github.io/index.mjs +++ b/src/js/github.io/index.mjs @@ -117,7 +117,7 @@ const capabilities = () => { let manifest = '\n' - const linkify = (method) => `[${method}](./ripple/${method.split('.').shift()}/#${method.match(/\.on[A-Z]/) ? method.split('.').pop().charAt(2).toLowerCase() + method.split('.').pop().substring(3).toLowerCase() : method.split('.').pop().toLowerCase()})` + const linkify = (method) => `[${method}](./lifecycle-manager/${method.split('.').shift()}/#${method.match(/\.on[A-Z]/) ? method.split('.').pop().charAt(2).toLowerCase() + method.split('.').pop().substring(3).toLowerCase() : method.split('.').pop().toLowerCase()})` Object.keys(capabilities).sort().forEach(c => { manifest += `### \`${c}\`\n` diff --git a/src/js/version-specification/apis.mjs b/src/js/version-specification/apis.mjs index 6c2276b..5d8608d 100644 --- a/src/js/version-specification/apis.mjs +++ b/src/js/version-specification/apis.mjs @@ -159,9 +159,9 @@ const run = async (version, parsedArgs) => { const v = `${legacy}.x` // create a temporary npm package and install the version of Firebolt we want to grab - await exec(`cd build; mkdir temp${legacy}; cd temp${legacy}; npm init -y ; npm install --saveDev @firebolt-js/lifecycle-manager-sdk@${v}`) + await exec(`cd build; mkdir temp${legacy}; cd temp${legacy}; npm init -y ; npm install --saveDev @firebolt-js/lifecycle-manager@${v}`) - version.apis[`${legacy}`] = await loadJson(`./build/temp${legacy}/node_modules/@firebolt-js/lifecycle-manager-sdk/dist/firebolt-open-rpc.json`) + version.apis[`${legacy}`] = await loadJson(`./build/temp${legacy}/node_modules/@firebolt-js/lifecycle-manager/dist/firebolt-open-rpc.json`) await exec(`cd build; rm -r temp${legacy}`) logSuccess(`Added version ${v}`) diff --git a/src/js/version.mjs b/src/js/version.mjs index a1710db..4d3b117 100755 --- a/src/js/version.mjs +++ b/src/js/version.mjs @@ -81,7 +81,7 @@ else if (task === 'validate') { console.log('Finding the latest prerelease') const prerelease = process.argv.shift() console.log('prerelease : ' + prerelease) - exec("npm show @firebolt-js/lifecycle-manager-sdk versions --json", (error, result, errlog) => { + exec("npm show @firebolt-js/lifecycle-manager versions --json", (error, result, errlog) => { if (error) { console.error(`error: ${error.message}`); return; diff --git a/src/json/firebolt-specification.json b/src/json/firebolt-specification.json index 39fd816..9565a20 100644 --- a/src/json/firebolt-specification.json +++ b/src/json/firebolt-specification.json @@ -3,7 +3,7 @@ "major": 1, "minor": 0, "patch": 0, - "readable": "Ripple SDK" + "readable": "Lifecycle Manager" }, "capabilities": { }, diff --git a/src/sdks/ripple/CHANGELOG.md b/src/sdks/lifecycle-manager/CHANGELOG.md similarity index 100% rename from src/sdks/ripple/CHANGELOG.md rename to src/sdks/lifecycle-manager/CHANGELOG.md diff --git a/src/sdks/ripple/CONTRIBUTING.md b/src/sdks/lifecycle-manager/CONTRIBUTING.md similarity index 100% rename from src/sdks/ripple/CONTRIBUTING.md rename to src/sdks/lifecycle-manager/CONTRIBUTING.md diff --git a/src/sdks/ripple/LICENSE b/src/sdks/lifecycle-manager/LICENSE similarity index 100% rename from src/sdks/ripple/LICENSE rename to src/sdks/lifecycle-manager/LICENSE diff --git a/src/sdks/ripple/NOTICE b/src/sdks/lifecycle-manager/NOTICE similarity index 100% rename from src/sdks/ripple/NOTICE rename to src/sdks/lifecycle-manager/NOTICE diff --git a/src/sdks/ripple/README.md b/src/sdks/lifecycle-manager/README.md similarity index 74% rename from src/sdks/ripple/README.md rename to src/sdks/lifecycle-manager/README.md index bf98730..e03c5b0 100644 --- a/src/sdks/ripple/README.md +++ b/src/sdks/lifecycle-manager/README.md @@ -1,23 +1,23 @@ --- -title: Firebolt Ripple SDK +title: Firebolt Lifecycle Manager SDK --- [![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) -# Firebolt Ripple SDK +# Firebolt Lifecycle Manager SDK For building Firebolt compliant apps that manage Firebolt devices. ## Usage To install, run: ``` -npm install @firebolt-extn-js/ripple-sdk +npm install @firebolt-js/lifecycle-manager ``` To use the package, import one of it's modules, e.g.: ```js -import { LifecycleManagement } from '@firebolt-extn-js/ripple-sdk' +import { LifecycleManagement } from '@firebolt-js/lifecycle-manager' ```