Skip to content

Commit

Permalink
fix: updated ripple to lifecycle-manager
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinshahfws committed Oct 10, 2024
1 parent b76775f commit f480345
Show file tree
Hide file tree
Showing 20 changed files with 32 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release-github.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -126,7 +126,7 @@ jobs:
# PRIVATE_KEY: ${{inputs.PRIVATE_KEY}}
# run: |
# cd /tmp
# git clone [email protected]:rdkcentral/ripple-doc.git ./firebolt-docs
# git clone [email protected]: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:
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Ripple RPC
title: Lifecycle Manager
---
Private Ripple RPC API for distributor integration.
Private Lifecycle Manager API for distributor integration.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -57,6 +57,7 @@
},
"keywords": [
"firebolt",
"lifecycle-manager",
"ripple"
],
"license": "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/js/github.io/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions src/js/version-specification/apis.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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}`)
Expand Down
2 changes: 1 addition & 1 deletion src/js/version.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion src/json/firebolt-specification.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"major": 1,
"minor": 0,
"patch": 0,
"readable": "Ripple SDK"
"readable": "Lifecycle Manager"
},
"capabilities": {
},
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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'
```

<!-- ## Contributing
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"name": "@firebolt-js/lifecycle-manager-sdk",
"name": "@firebolt-js/lifecycle-manager",
"version": "1.1.0-next.1",
"description": "The Ripple JS SDK",
"main": "./dist/lib/ripple.mjs",
"types": "./dist/lib/ripple.d.ts",
"description": "The lifecycle-manager JS SDK",
"main": "./dist/lib/lifecycle-manager.mjs",
"types": "./dist/lib/lifecycle-manager.d.ts",
"type": "module",
"scripts": {
"validate": "npx firebolt-openrpc validate --input ./dist/ripple-open-rpc.json",
"sdk": "npx firebolt-openrpc sdk --input ./dist/ripple-open-rpc.json --template ./src/js --output ./build/javascript/src",
"validate": "npx firebolt-openrpc validate --input ./dist/lifecycle-manager-open-rpc.json",
"sdk": "npx firebolt-openrpc sdk --input ./dist/lifecycle-manager-open-rpc.json --template ./src/js --output ./build/javascript/src",
"compile": "cd ../../.. && npm run compile",
"slice": "npx firebolt-openrpc slice -i ../../../dist/firebolt-open-rpc.json --sdk ./sdk.config.json -o ./dist/ripple-open-rpc.json",
"docs": "npx firebolt-openrpc docs --input ./dist/ripple-open-rpc.json --output build/docs/markdown --as-path",
"wiki": "npx firebolt-openrpc docs --input ./dist/ripple-open-rpc.json --output build/docs/wiki",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run prettier && npm run dist:copy && echo 'Firebolt Ripple SDK /dist/ is ready.\n'",
"slice": "npx firebolt-openrpc slice -i ../../../dist/firebolt-open-rpc.json --sdk ./sdk.config.json -o ./dist/lifecycle-manager-open-rpc.json",
"docs": "npx firebolt-openrpc docs --input ./dist/lifecycle-manager-open-rpc.json --output build/docs/markdown --as-path",
"wiki": "npx firebolt-openrpc docs --input ./dist/lifecycle-manager-open-rpc.json --output build/docs/wiki",
"dist:notest": "npm run clean && npm run slice && npm run validate && npm run sdk && npm run docs && npm run prettier && npm run dist:copy && echo 'Firebolt lifecycle-manager SDK /dist/ is ready.\n'",
"dist:copy": "npm run dist:copy:sdk && npm run dist:copy:docs",
"dist:copy:sdk": "mkdirp ./dist && cp -R build/javascript/src dist/lib && cp ./dist/ripple-open-rpc.json ../../../dist/ripple-open-rpc.json",
"dist:copy:sdk": "mkdirp ./dist && cp -R build/javascript/src dist/lib && cp ./dist/lifecycle-manager-open-rpc.json ../../../dist/lifecycle-manager-open-rpc.json",
"dist:copy:docs": "mkdirp ./dist && cp -R build/docs/markdown dist/docs",
"dist": "npm run dist:notest && npm run test",
"clean": "rm -rf ./build && rm -rf ./dist",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"info": {
"title": "Ripple SDK",
"title": "Lifecycle Manager SDK",
"x-interface-names": {}
},
"methods": [
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/template/openrpc/template.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openrpc": "1.2.4",
"info": {
"title": "Ripple",
"title": "Lifecycle Manager",
"version": "0.0.0"
},
"methods": [
Expand Down

0 comments on commit f480345

Please sign in to comment.