Merge pull request #34 from runwayml/release-please--branches--main--…

…changes--next--components--sdk

release: 1.4.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.3.0"
+  ".": "1.4.0"
 }

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.4.0 (2024-11-28)
+
+Full Changelog: [v1.3.0...v1.4.0](https://github.com/runwayml/sdk-node/compare/v1.3.0...v1.4.0)
+
+### Features
+
+* **internal:** make git install file structure match npm ([#38](https://github.com/runwayml/sdk-node/issues/38)) ([d784a50](https://github.com/runwayml/sdk-node/commit/d784a500723af1278295edcdcfcc1396f1ff4d56))
+
+
+### Chores
+
+* rebuild project due to codegen change ([#33](https://github.com/runwayml/sdk-node/issues/33)) ([f72b350](https://github.com/runwayml/sdk-node/commit/f72b350bd214fa3e2dc50a35882279497b0c1540))
+* rebuild project due to codegen change ([#35](https://github.com/runwayml/sdk-node/issues/35)) ([dba4d69](https://github.com/runwayml/sdk-node/commit/dba4d69941e7a075b91fb3f860b3e44710683025))
+* remove redundant word in comment ([#37](https://github.com/runwayml/sdk-node/issues/37)) ([b84a2b2](https://github.com/runwayml/sdk-node/commit/b84a2b22fd6a6ee966d909e6038cbc689b131314))
+
+
+### Documentation
+
+* remove suggestion to use `npm` call out ([#36](https://github.com/runwayml/sdk-node/issues/36)) ([316e011](https://github.com/runwayml/sdk-node/commit/316e0116da78bef877be5ba6525d29b645fe252d))
+
 ## 1.3.0 (2024-11-06)
 
 Full Changelog: [v1.2.0...v1.3.0](https://github.com/runwayml/sdk-node/compare/v1.2.0...v1.3.0)

README.md

@@ -314,7 +314,7 @@ TypeScript >= 4.5 is supported.
 The following runtimes are supported:
 
 - Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
-- Deno v1.28.0 or higher, using `import RunwayML from "npm:@runwayml/sdk"`.
+- Deno v1.28.0 or higher.
 - Bun 1.0 or later.
 - Cloudflare Workers.
 - Vercel Edge Runtime.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runwayml/sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "The official TypeScript library for the RunwayML API",
   "author": "RunwayML <dev-feedback@runwayml.com>",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "build": "./scripts/build",
     "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1",
     "format": "prettier --write --cache --cache-strategy metadata . !dist",
-    "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",
+    "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build && ./scripts/utils/git-swap.sh; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
     "lint": "./scripts/lint",
     "fix": "./scripts/format"
@@ -45,7 +45,6 @@
     "jest": "^29.4.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.1.0",
-    "ts-morph": "^19.0.0",
     "ts-node": "^10.5.0",
     "tsc-multi": "^1.1.0",
     "tsconfig-paths": "^4.0.0",

scripts/build

@@ -32,7 +32,7 @@ npm exec tsc-multi
 # copy over handwritten .js/.mjs/.d.ts files
 cp src/_shims/*.{d.ts,js,mjs,md} dist/_shims
 cp src/_shims/auto/*.{d.ts,js,mjs} dist/_shims/auto
-# we need to add exports = module.exports = RunwayML Node to index.js;
+# we need to add exports = module.exports = RunwayML to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
 node scripts/utils/fix-index-exports.cjs

scripts/utils/check-is-in-git-install.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # Check if you happen to call prepare for a repository that's already in node_modules.
 [ "$(basename "$(dirname "$PWD")")" = 'node_modules' ] ||
 # The name of the containing directory that 'npm` uses, which looks like

scripts/utils/git-swap.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -exuo pipefail
+# the package is published to NPM from ./dist
+# we want the final file structure for git installs to match the npm installs, so we
+
+# delete everything except ./dist and ./node_modules
+find . -maxdepth 1 -mindepth 1 ! -name 'dist' ! -name 'node_modules' -exec rm -rf '{}' +
+
+# move everything from ./dist to .
+mv dist/* .
+
+# delete the now-empty ./dist
+rmdir dist

src/index.ts

@@ -178,6 +178,21 @@ export class RunwayML extends Core.APIClient {
   static fileFromPath = Uploads.fileFromPath;
 }
 
+RunwayML.Tasks = Tasks;
+RunwayML.ImageToVideo = ImageToVideo;
+export declare namespace RunwayML {
+  export type RequestOptions = Core.RequestOptions;
+
+  export { Tasks as Tasks, type TaskRetrieveResponse as TaskRetrieveResponse };
+
+  export {
+    ImageToVideo as ImageToVideo,
+    type ImageToVideoCreateResponse as ImageToVideoCreateResponse,
+    type ImageToVideoCreateParams as ImageToVideoCreateParams,
+  };
+}
+
+export { toFile, fileFromPath } from './uploads';
 export {
   RunwayMLError,
   APIError,
@@ -194,22 +209,4 @@ export {
   UnprocessableEntityError,
 } from './error';
 
-export import toFile = Uploads.toFile;
-export import fileFromPath = Uploads.fileFromPath;
-
-RunwayML.Tasks = Tasks;
-RunwayML.ImageToVideo = ImageToVideo;
-
-export declare namespace RunwayML {
-  export type RequestOptions = Core.RequestOptions;
-
-  export { Tasks as Tasks, type TaskRetrieveResponse as TaskRetrieveResponse };
-
-  export {
-    ImageToVideo as ImageToVideo,
-    type ImageToVideoCreateResponse as ImageToVideoCreateResponse,
-    type ImageToVideoCreateParams as ImageToVideoCreateParams,
-  };
-}
-
 export default RunwayML;

src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.3.0'; // x-release-please-version
+export const VERSION = '1.4.0'; // x-release-please-version

yarn.lock

@@ -759,16 +759,6 @@
   dependencies:
     "@swc/counter" "^0.1.3"
 
-"@ts-morph/common@~0.20.0":
-  version "0.20.0"
-  resolved "https://registry.yarnpkg.com/@ts-morph/common/-/common-0.20.0.tgz#3f161996b085ba4519731e4d24c35f6cba5b80af"
-  integrity sha512-7uKjByfbPpwuzkstL3L5MQyuXPSKdoNG93Fmi2JoDcTf3pEP731JdRFAduRVkOs8oqxPsXKA+ScrWkdQ8t/I+Q==
-  dependencies:
-    fast-glob "^3.2.12"
-    minimatch "^7.4.3"
-    mkdirp "^2.1.6"
-    path-browserify "^1.0.1"
-
 "@tsconfig/node10@^1.0.7":
   version "1.0.8"
   resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.8.tgz#c1e4e80d6f964fbecb3359c43bd48b40f7cadad9"
@@ -1315,11 +1305,6 @@ co@^4.6.0:
   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
   integrity sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==
 
-code-block-writer@^12.0.0:
-  version "12.0.0"
-  resolved "https://registry.yarnpkg.com/code-block-writer/-/code-block-writer-12.0.0.tgz#4dd58946eb4234105aff7f0035977b2afdc2a770"
-  integrity sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w==
-
 collect-v8-coverage@^1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz#c0b29bcd33bcd0779a1344c2136051e6afd3d9e9"
@@ -2680,23 +2665,11 @@ minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1, minimatch@^3.1.2:
   dependencies:
     brace-expansion "^1.1.7"
 
-minimatch@^7.4.3:
-  version "7.4.6"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb"
-  integrity sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==
-  dependencies:
-    brace-expansion "^2.0.1"
-
 minimist@^1.2.6:
   version "1.2.6"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
   integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==
 
-mkdirp@^2.1.6:
-  version "2.1.6"
-  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-2.1.6.tgz#964fbcb12b2d8c5d6fbc62a963ac95a273e2cc19"
-  integrity sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A==
-
 ms@2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
@@ -2860,11 +2833,6 @@ parse-json@^5.2.0:
     json-parse-even-better-errors "^2.3.0"
     lines-and-columns "^1.1.6"
 
-path-browserify@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd"
-  integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==
-
 path-exists@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3"
@@ -3283,14 +3251,6 @@ ts-jest@^29.1.0:
     semver "^7.5.3"
     yargs-parser "^21.0.1"
 
-ts-morph@^19.0.0:
-  version "19.0.0"
-  resolved "https://registry.yarnpkg.com/ts-morph/-/ts-morph-19.0.0.tgz#43e95fb0156c3fe3c77c814ac26b7d0be2f93169"
-  integrity sha512-D6qcpiJdn46tUqV45vr5UGM2dnIEuTGNxVhg0sk5NX11orcouwj6i1bMqZIz2mZTZB1Hcgy7C3oEVhAT+f6mbQ==
-  dependencies:
-    "@ts-morph/common" "~0.20.0"
-    code-block-writer "^12.0.0"
-
 ts-node@^10.5.0:
   version "10.7.0"
   resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.7.0.tgz#35d503d0fab3e2baa672a0e94f4b40653c2463f5"