diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 714a5583..bf032a1a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ -### Pull request for @Cloudinary/Base +### Pull request for @cloudinary/js-url-gen #### What does this PR solve? diff --git a/CHANGELOG.md b/CHANGELOG.md index 18286e2c..79e40158 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -128,7 +128,7 @@ Breaking changes Other changes ================ - * Docs - Fix styling in the search component when searching for @cloudinary/base (#338) + * Docs - Fix styling in the search component when searching for @cloudinary/js-url-gen (#338) * Docs - Change wording of SDK Summary when searching (#337) * Build - Set the bundle target to ES6 for ESM, and ES5 for UMD (#335) * Docs - Enhance the search diff --git a/README.md b/README.md index 503c6cb5..4a8ea380 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,14 @@ This SDK can also be used with [popular frontend frameworks](https://cloudinary. ## Installation ```bash -npm install @cloudinary/base +npm install @cloudinary/js-url-gen ``` ## Simple usage ```javascript // Import the Cloudinary class -import {Cloudinary} from '@cloudinary/base'; +import {Cloudinary} from '@cloudinary/js-url-gen'; // Create your instance const cld = new Cloudinary({ @@ -35,7 +35,7 @@ const cld = new Cloudinary({ // Let's create a new image const myImage = cld.image('sample'); -import {Resize} from '@cloudinary/base/actions/resize'; +import {Resize} from '@cloudinary/js-url-gen/actions/resize'; myImage.resize(Resize.scale().width(100).height(100)); // When we're done, we can apply all our changes and create a URL. @@ -56,22 +56,22 @@ console.log(myURL); ### Transpilation -@cloudinary/base is shipped as untranspiled ES6 code. -@cloudinary/base is optimized around bundle size, as such we do not transpile our distributed modules, +@cloudinary/js-url-gen is shipped as untranspiled ES6 code. +@cloudinary/js-url-gen is optimized around bundle size, as such we do not transpile our distributed modules, we leave the decision of what browsers to support, and what transpilations to apply, to you, the user. ### Testing with Jest -As mentioned above, we're shipping @cloudinary/base with ES6 code, as this provides great tree-shaking potential. +As mentioned above, we're shipping @cloudinary/js-url-gen with ES6 code, as this provides great tree-shaking potential. it also requires a few adjustments when testing. In jest.config, you'll need to add these lines to allow babel to transpile our code. ```json { "transform": { - "node_modules/@cloudinary/base": "babel-jest" + "node_modules/@cloudinary/js-url-gen": "babel-jest" }, - "transformIgnorePatterns": ["/node_modules/(?!@cloudinary/base)"] + "transformIgnorePatterns": ["/node_modules/(?!@cloudinary/js-url-gen)"] } ``` Make sure to install babel-jest: diff --git a/__DOCS__/examples/annotatedExamples/configuration.md b/__DOCS__/examples/annotatedExamples/configuration.md index 0b6ba9a5..88760955 100644 --- a/__DOCS__/examples/annotatedExamples/configuration.md +++ b/__DOCS__/examples/annotatedExamples/configuration.md @@ -2,7 +2,7 @@ ```javascript // Import the cloudinary class -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; // Create your instance const cld = new Cloudinary({ diff --git a/__DOCS__/examples/annotatedExamples/imageOverlay.md b/__DOCS__/examples/annotatedExamples/imageOverlay.md index c0b9731d..8ff0dea7 100644 --- a/__DOCS__/examples/annotatedExamples/imageOverlay.md +++ b/__DOCS__/examples/annotatedExamples/imageOverlay.md @@ -1,6 +1,6 @@ ```javascript // Import the cloudinary class -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; // Create your instance const cld = new Cloudinary({ @@ -17,18 +17,18 @@ const myImage = cld.image('sample'); // An overlay is built from several parts // Import video or image overlay, based on your asset -import {Overlay} from "@cloudinary/base/actions/overlay"; +import {Overlay} from "@cloudinary/js-url-gen/actions/overlay"; // Import the source of the layer, this determines if the layer is an image, text or video -import {image} from "@cloudinary/base/qualifiers/source"; +import {image} from "@cloudinary/js-url-gen/qualifiers/source"; // Import how to position your layer -import {Position} from "@cloudinary/base/qualifiers/position"; -import {southEast} from "@cloudinary/base/qualifiers/compass"; -import {compass} from "@cloudinary/base/qualifiers/gravity"; +import {Position} from "@cloudinary/js-url-gen/qualifiers/position"; +import {southEast} from "@cloudinary/js-url-gen/qualifiers/compass"; +import {compass} from "@cloudinary/js-url-gen/qualifiers/gravity"; // We'll also scale our overlay, we'll need this for later. -import {scale} from "@cloudinary/base/actions/resize"; -import {Transformation} from "@cloudinary/base/transformation/Transformation"; +import {scale} from "@cloudinary/js-url-gen/actions/resize"; +import {Transformation} from "@cloudinary/js-url-gen/transformation/Transformation"; myImage.overlay( diff --git a/__DOCS__/examples/annotatedExamples/resize.md b/__DOCS__/examples/annotatedExamples/resize.md index 6e537c34..e304fb7d 100644 --- a/__DOCS__/examples/annotatedExamples/resize.md +++ b/__DOCS__/examples/annotatedExamples/resize.md @@ -1,6 +1,6 @@ ```javascript // Import the cloudinary class -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; // Create your instance const cld = new Cloudinary({ @@ -26,9 +26,9 @@ const myImage = cld.image('sample'); // the resize() ActionGroup needs an Action parameter // Lets give resize() a ResizeScale paramter to scale our image -// We import all of our Action parameters from @cloudinary/base/actions/{actionGroup} +// We import all of our Action parameters from @cloudinary/js-url-gen/actions/{actionGroup} // Note that you can import all Resize Actions, or just the single one you want -import {Resize} from "@cloudinary/base/actions/resize"; +import {Resize} from "@cloudinary/js-url-gen/actions/resize"; const {scale} = Resize; // Resize.scale === scale // Explore the Resize object to discover more resize actions diff --git a/__DOCS__/examples/annotatedExamples/rotate.md b/__DOCS__/examples/annotatedExamples/rotate.md index d6193de4..2bf1233f 100644 --- a/__DOCS__/examples/annotatedExamples/rotate.md +++ b/__DOCS__/examples/annotatedExamples/rotate.md @@ -1,5 +1,5 @@ ```javascript -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; const cld = new Cloudinary({ cloud: { @@ -12,7 +12,7 @@ const cld = new Cloudinary({ // Import the RotationModeAction -import {mode} from '@cloudinary/base/actions/rotate'; +import {mode} from '@cloudinary/js-url-gen/actions/rotate'; // Remember, mode is a function that returns an Action // but we refer to both as a RotationMode action @@ -20,10 +20,10 @@ import {mode} from '@cloudinary/base/actions/rotate'; // The RotationModeAction (mode) requires a Qualifier // That qualifier will require a certain QualifierValue // To make life easier, you can import all possible QualifierValue(s) of rotate -import {RotationMode} from '@cloudinary/base/qualifiers/rotationMode'; +import {RotationMode} from '@cloudinary/js-url-gen/qualifiers/rotationMode'; // You can also import only the required QualifierValue you want -import {verticalFlip} from '@cloudinary/base/qualifiers/rotationMode'; +import {verticalFlip} from '@cloudinary/js-url-gen/qualifiers/rotationMode'; // RotationMode.verticalFlip === verticalFlip const myImage = cld.image('sample'); diff --git a/__DOCS__/examples/gettingStarted/helloworld.md b/__DOCS__/examples/gettingStarted/helloworld.md index e6bb999e..36c15273 100644 --- a/__DOCS__/examples/gettingStarted/helloworld.md +++ b/__DOCS__/examples/gettingStarted/helloworld.md @@ -3,8 +3,8 @@

Code Example

```javascript -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; -import {scale} from "@cloudinary/base/actions/resize"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; +import {scale} from "@cloudinary/js-url-gen/actions/resize"; // Create your instance const cld = new Cloudinary({ @@ -38,7 +38,7 @@ const myURL = myImage.toURL();
  • Creates a new Cloudinary instance, with a set of configurations
  • Instructs your instance to work with a Cloudinary Image (CloudinaryImage)
  • Creates a new CloudinaryImage instance with a publicID of 'sample' (cld.image('sample'))
    • -
  • Imports the scale() Action from '@cloudinary/base/actions/resize'
    • +
  • Imports the scale() Action from '@cloudinary/js-url-gen/actions/resize'
  • Uses the Action methods width and height to set the scale size
  • Applies your changes and creates a URL string
    • diff --git a/__DOCS__/examples/gettingStarted/installation.md b/__DOCS__/examples/gettingStarted/installation.md index 175f91e8..94c6d9d0 100644 --- a/__DOCS__/examples/gettingStarted/installation.md +++ b/__DOCS__/examples/gettingStarted/installation.md @@ -1,3 +1,3 @@

    Installation

    Installing through npm

    - npm install @cloudinary/base + npm install @cloudinary/js-url-gen diff --git a/__DOCS__/examples/gettingStarted/terminology.md b/__DOCS__/examples/gettingStarted/terminology.md index 6c4f639a..12fb9b5a 100644 --- a/__DOCS__/examples/gettingStarted/terminology.md +++ b/__DOCS__/examples/gettingStarted/terminology.md @@ -4,10 +4,10 @@ ```javascript -import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; -import {Rotate} from "@cloudinary/base/actions/rotate"; -import {Resize} from "@cloudinary/base/actions/resize"; -import {RotationMode} from "@cloudinary/base/qualifiers/rotationMode"; +import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; +import {Rotate} from "@cloudinary/js-url-gen/actions/rotate"; +import {Resize} from "@cloudinary/js-url-gen/actions/resize"; +import {RotationMode} from "@cloudinary/js-url-gen/qualifiers/rotationMode"; // Create your instance const cld = new Cloudinary({ @@ -45,8 +45,8 @@ myImage
  • Assets expose methods called ActionGroups (image.resize, image.rotate)
  • ActionGroups receive an Action as a parameter
  • We create Action objects through Factory methods (scale, mode) -
  • You can find more Actions in '@cloudinary/base/actions' -
  • You can import all actions from import {Actions} from '@cloudinary/base' +
  • You can find more Actions in '@cloudinary/js-url-gen/actions' +
  • You can import all actions from import {Actions} from '@cloudinary/js-url-gen' @@ -57,7 +57,7 @@ myImage
  • Qualifiers usually accept a QualifierValue
  • QualifierValues can be primitive (numbers, strings) or predefined SDK values that can be imported
  • Almost all QualifierValues are functions (RotationMode.verticalFlip()) -
  • You can find more QualifierValues in '@cloudinary/base/values' +
  • You can find more QualifierValues in '@cloudinary/js-url-gen/values'

    Generalized form

    diff --git a/__DOCS__/examples/gettingStarted/treeShaking.md b/__DOCS__/examples/gettingStarted/treeShaking.md index 3d43c284..9bbf4c22 100644 --- a/__DOCS__/examples/gettingStarted/treeShaking.md +++ b/__DOCS__/examples/gettingStarted/treeShaking.md @@ -16,7 +16,7 @@ Everything can be very granularly imported to ensure you only import what you ne

    Without Tree-Shaking

    ```javascript - import {Resize} from "@cloudinary/base/actions/resize"; + import {Resize} from "@cloudinary/js-url-gen/actions/resize"; Resize.scale() Resize.crop() @@ -24,7 +24,7 @@ Everything can be very granularly imported to ensure you only import what you ne

    With Tree-Shaking

    ```javascript - import {scale, crop} from '@cloudinary/base/actions/resize'; + import {scale, crop} from '@cloudinary/js-url-gen/actions/resize'; scale() crop() ``` @@ -37,7 +37,7 @@ Everything can be very granularly imported to ensure you only import what you ne

    Without Tree-Shaking

    ```javascript - import {Format} from "@cloudinary/base/qualifiers/format"; + import {Format} from "@cloudinary/js-url-gen/qualifiers/format"; Format.png() Format.jpg() @@ -45,7 +45,7 @@ Everything can be very granularly imported to ensure you only import what you ne

    With Tree-Shaking

    ```javascript - import {jpg, png} from "@cloudinary/base/qualifiers/format"; + import {jpg, png} from "@cloudinary/js-url-gen/qualifiers/format"; png() jpg() diff --git a/jsdoc.config.json b/jsdoc.config.json index c2e9824c..b3f9f773 100644 --- a/jsdoc.config.json +++ b/jsdoc.config.json @@ -32,7 +32,7 @@ "systemColor": "#3448C5", "systemName": "Cloudinary Base SDK", "systemLogo": "./__DOCS__/resources/navLogo.png", - "systemSummary": "@cloudinary/base", + "systemSummary": "@cloudinary/js-url-gen", "favicon": "./__DOCS__/resources/favico.png", "copyright": "Copyright © 2021 Cloudinary.com" }, diff --git a/package.json b/package.json index 233a7cc6..3aa67255 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@cloudinary/base", + "name": "@cloudinary/js-url-gen", "version": "1.0.0-beta.4", "description": "", "scripts": { diff --git a/scripts/lib/entryPointsLib.ts b/scripts/lib/entryPointsLib.ts index c82ed91c..d734cd59 100644 --- a/scripts/lib/entryPointsLib.ts +++ b/scripts/lib/entryPointsLib.ts @@ -30,7 +30,7 @@ function createUMDBundleEntryPoint() { /** * @description Since only ./dist/ is packaged to npm, we need to copy a proper package.json file to it - * That will allow `import {TransformableImage} from '@cloudinary/base` + * That will allow `import {TransformableImage} from '@cloudinary/js-url-gen` */ function copyPackageJson(fileDestination = 'dist') { const projectJson = JSON.parse(fs.readFileSync('./package.json', 'utf-8')); diff --git a/src/actions/animated.ts b/src/actions/animated.ts index 735aaf82..6a9fe6ee 100644 --- a/src/actions/animated.ts +++ b/src/actions/animated.ts @@ -10,8 +10,8 @@ import {QualifierValue} from "../internal/qualifier/QualifierValue"; * @memberOf Actions * @namespace Animated * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {animated} from "@cloudinary/base/actions/animated"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {animated} from "@cloudinary/js-url-gen/actions/animated"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -24,8 +24,8 @@ import {QualifierValue} from "../internal/qualifier/QualifierValue"; * @see Actions.Animated * @example * // Used through a builder function Animated.edit(), and not by creating a new instance - * import {Cloudinary} from "@cloudinary/base"; - * import {edit} from "@cloudinary/base/actions/animated"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {edit} from "@cloudinary/js-url-gen/actions/animated"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/border.ts b/src/actions/border.ts index 697dad5f..26484d7d 100644 --- a/src/actions/border.ts +++ b/src/actions/border.ts @@ -14,8 +14,8 @@ import RoundCornersAction from "./roundCorners/RoundCornersAction"; * @memberOf Actions * @namespace Border * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {solid} from "@cloudinary/base/actions/border"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {solid} from "@cloudinary/js-url-gen/actions/border"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -34,7 +34,7 @@ import RoundCornersAction from "./roundCorners/RoundCornersAction"; * @see Actions.Border * @example * // Used through a builder function Border.solid(), and not by creating a new instance - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/conditional.ts b/src/actions/conditional.ts index 414bac5e..f82117c4 100644 --- a/src/actions/conditional.ts +++ b/src/actions/conditional.ts @@ -7,7 +7,7 @@ import {Transformation} from "../transformation/Transformation"; * @memberOf Actions * @namespace Conditional * @example - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -24,7 +24,7 @@ import {Transformation} from "../transformation/Transformation"; * @see Actions.Conditional * @example * // To be used through a builder and not to be created as an instance! - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/customFunction.ts b/src/actions/customFunction.ts index f07b6d84..911ac86d 100644 --- a/src/actions/customFunction.ts +++ b/src/actions/customFunction.ts @@ -4,8 +4,8 @@ * @memberOf Actions * @namespace CustomFunction * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {remote, wasm} from "@cloudinary/base/actions/customFunction"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {remote, wasm} from "@cloudinary/js-url-gen/actions/customFunction"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/delivery.ts b/src/actions/delivery.ts index 21e53918..ea042178 100644 --- a/src/actions/delivery.ts +++ b/src/actions/delivery.ts @@ -31,8 +31,8 @@ export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceFromICC; * possible values * @return {Actions.Delivery.DeliveryFormat} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {format} from "@cloudinary/base/actions/delivery"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {format} from "@cloudinary/js-url-gen/actions/delivery"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -54,8 +54,8 @@ function format(format:FormatQualifier | ImageFormatType | VideoFormatType | str * @param {string} dpr The DPR (Device Pixel Ratio). Any positive float value. * @return {Actions.Delivery.DeliveryAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {dpr} from "@cloudinary/base/actions/delivery"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {dpr} from "@cloudinary/js-url-gen/actions/delivery"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -81,9 +81,9 @@ function dpr(dpr: string|number):DeliveryAction { * possible values. * @return {Actions.Delivery.DeliveryQualityAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {quality} from "@cloudinary/base/actions/delivery"; - * import {quality} from "@cloudinary/base/qualifiers/quantity"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {quality} from "@cloudinary/js-url-gen/actions/delivery"; + * import {quality} from "@cloudinary/js-url-gen/qualifiers/quantity"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -103,8 +103,8 @@ function quality(qualityType:QualityTypes | string | number) :DeliveryQualityAct * @param {number | string} value The density in dpi. * @return {Actions.Delivery.DeliveryAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {density} from "@cloudinary/base/actions/delivery"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {density} from "@cloudinary/js-url-gen/actions/delivery"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -125,8 +125,8 @@ function density(value:number) :DeliveryAction { * @param {string} publicIdWithExtension Default image public ID * @return {Actions.Delivery.DeliveryAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {defaultImage} from "@cloudinary/base/actions/delivery"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {defaultImage} from "@cloudinary/js-url-gen/actions/delivery"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -146,9 +146,9 @@ function defaultImage(publicIdWithExtension:string) :DeliveryAction { * @param {string | Qualifiers.ColorSpace} mode The color space. * @return {Actions.Delivery.DeliveryAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {colorSpace} from "@cloudinary/base/actions/delivery"; - * import {trueColor} from "@cloudinary/base/qualifiers/colorSpace"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {colorSpace} from "@cloudinary/js-url-gen/actions/delivery"; + * import {trueColor} from "@cloudinary/js-url-gen/qualifiers/colorSpace"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -170,9 +170,9 @@ function colorSpace(mode:ColorSpaceType|string): DeliveryAction { * color space. * @return {Actions.Delivery.DeliveryColorSpaceFromICC} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {colorSpaceFromICC} from "@cloudinary/base/actions/delivery"; - * import {trueColor} from "@cloudinary/base/qualifiers/colorSpace"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {colorSpaceFromICC} from "@cloudinary/js-url-gen/actions/delivery"; + * import {trueColor} from "@cloudinary/js-url-gen/qualifiers/colorSpace"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/effect.ts b/src/actions/effect.ts index 694ff8c0..efc4ac90 100644 --- a/src/actions/effect.ts +++ b/src/actions/effect.ts @@ -138,7 +138,7 @@ function outline(): EffectOutline { * @description Applies a complex deep learning neural network algorithm that extracts artistic styles from a source image and applies them to the content of a target photograph.
    * Learn more: {@link https://cloudinary.com/documentation/neural_artwork_style_transfer_addon | Neural Artwork Style Transfer} * @memberOf Actions.Effect - * @param {ImageSource} imageSource `import {image} from '@cloudinary/base/qualifiers/sources` + * @param {ImageSource} imageSource `import {image} from '@cloudinary/js-url-gen/qualifiers/sources` * @return {Actions.Effect.StyleTransfer} */ function styleTransfer(imageSource: ImageSource): StyleTransfer { @@ -318,7 +318,7 @@ function vignette(strength?: number):EffectActionWithStrength { * @summary action * @description * Applies an ordered dither filter to the image. - * Use the constants defined in {@link Qualifiers.Dither|@cloudinary/base/qualifiers/dither} for ditherType. + * Use the constants defined in {@link Qualifiers.Dither|@cloudinary/js-url-gen/qualifiers/dither} for ditherType. * @memberOf Actions.Effect * @param {Qualifiers.Dither} ditherType - The dither type applied to the image * @return {Actions.Effect.DitherEffectAction} @@ -455,9 +455,9 @@ function theme(color: SystemColors): ThemeEffect { * @namespace Effect * @example * An extreme example of using many effects on the same asset - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * // Import everything, or just the action you need for tree-shaking purposes - * import {Effect, sepia} from "@cloudinary/base/actions/effect"; + * import {Effect, sepia} from "@cloudinary/js-url-gen/actions/effect"; * import {ArtisticFilter, alDente} from "../../../src/qualifiers/artisticFilter"; * import {ShakeStrength, pixels16} from "../../../src/qualifiers/shakeStrength"; * diff --git a/src/actions/effect/styleTransfer.ts b/src/actions/effect/styleTransfer.ts index 2cb212bc..ac73ed36 100644 --- a/src/actions/effect/styleTransfer.ts +++ b/src/actions/effect/styleTransfer.ts @@ -21,7 +21,7 @@ class StyleTransfer extends Action { /** * The Image Source used to create the style transfer, * Use the Image Source builder to quickly create a source: - *
    Import: {@link Qualifiers.Source|import Sources from '@cloudinary/base/qualifiers/sources';} + *
    Import: {@link Qualifiers.Source|import Sources from '@cloudinary/js-url-gen/qualifiers/sources';} *
    Create: `Source.image('dog')` * @param {ImageSource} imageSource */ diff --git a/src/actions/extract.ts b/src/actions/extract.ts index 8db9bc6b..6d87b7fd 100644 --- a/src/actions/extract.ts +++ b/src/actions/extract.ts @@ -7,12 +7,12 @@ import {Action} from "../internal/Action"; * @memberOf Actions * @namespace Extract * @example - * import {Cloudinary} from '@cloudinary/base'; + * import {Cloudinary} from '@cloudinary/js-url-gen'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); * - * import {getFrame, getPage} from '@cloudinary/base/actions/extract'; + * import {getFrame, getPage} from '@cloudinary/js-url-gen/actions/extract'; * * image.extract( * getFrame() diff --git a/src/actions/namedTransformation.ts b/src/actions/namedTransformation.ts index 80092025..90dd205e 100644 --- a/src/actions/namedTransformation.ts +++ b/src/actions/namedTransformation.ts @@ -5,8 +5,8 @@ import {NamedTransformationAction} from "./namedTransformation/NamedTransformati * @memberOf Actions * @namespace NamedTransformation * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {name} from "@cloudinary/base/actions/namedTransformation"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {name} from "@cloudinary/js-url-gen/actions/namedTransformation"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/overlay.ts b/src/actions/overlay.ts index 84cb1f50..f666fc25 100644 --- a/src/actions/overlay.ts +++ b/src/actions/overlay.ts @@ -8,14 +8,14 @@ import {LayerAction} from "./layer/LayerAction"; * @see Visit {@link Qualifiers.TextStyle|TextStyle} for advanced text options * @see {@link Actions.Underlay| The underlay action} * @example - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const myVideo = yourCldInstance.video('dog'); * - * import {source} from "@cloudinary/base/actions/overlay" - * import {image, video, text} from "@cloudinary/base/qualifiers/source" - * import {TextStyle} from '@cloudinary/base/qualifiers/textStyle + * import {source} from "@cloudinary/js-url-gen/actions/overlay" + * import {image, video, text} from "@cloudinary/js-url-gen/qualifiers/source" + * import {TextStyle} from '@cloudinary/js-url-gen/qualifiers/textStyle * * myVideo.overlay( * source(image('myImage')) diff --git a/src/actions/psdTools.ts b/src/actions/psdTools.ts index 5849e32b..5462b43b 100644 --- a/src/actions/psdTools.ts +++ b/src/actions/psdTools.ts @@ -18,8 +18,8 @@ import {SmartObjectAction} from "./psdTools/SmartObjectAction"; * @memberOf Actions.PSDTools * @return {Actions.PSDTools.ClipAction} * @example - * import {Cloudinary} from '@cloudinary/base'; - * import {clip} from '@cloudinary/base/actions/psdTools'; + * import {Cloudinary} from '@cloudinary/js-url-gen'; + * import {clip} from '@cloudinary/js-url-gen/actions/psdTools'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -43,8 +43,8 @@ function clip(): ClipAction { * @memberOf Actions.PSDTools * @return {Actions.PSDTools.GetLayerAction} * @example - * import {Cloudinary} from '@cloudinary/base'; - * import {getLayer} from '@cloudinary/base/actions/psdTools'; + * import {Cloudinary} from '@cloudinary/js-url-gen'; + * import {getLayer} from '@cloudinary/js-url-gen/actions/psdTools'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); @@ -66,8 +66,8 @@ function getLayer(): GetLayerAction { * @memberOf Actions.PSDTools * @return {Actions.PSDTools.SmartObjectAction} * @example - * import {Cloudinary} from '@cloudinary/base'; - * import {smartObject} from '@cloudinary/base/actions/psdTools'; + * import {Cloudinary} from '@cloudinary/js-url-gen'; + * import {smartObject} from '@cloudinary/js-url-gen/actions/psdTools'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/reshape.ts b/src/actions/reshape.ts index f0b8abea..c6ab242a 100644 --- a/src/actions/reshape.ts +++ b/src/actions/reshape.ts @@ -31,13 +31,13 @@ type IReshape = CutByImage | DistortArcAction; * @return {Actions.Reshape.CutByImage} * @example *

    Cut an image by using another image(Gravity)

    - * import {Cloudinary, Transformation} from "@cloudinary/base"; + * import {Cloudinary, Transformation} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const img = yourCldInstance.image('woman'); * - * import {cutByImage} from '@cloudinary/base/actions/reshape'; - * import {image} from "@cloudinary/base/qualifiers/source"; + * import {cutByImage} from '@cloudinary/js-url-gen/actions/reshape'; + * import {image} from "@cloudinary/js-url-gen/qualifiers/source"; * * img.reshape( * cutByImage( @@ -61,12 +61,12 @@ function cutByImage(imageSource: ImageSource | TextSource | FetchSource): CutByI * @return {Actions.Reshape.DistortArcAction} * @example *

    Distort arc

    - * import {Cloudinary, Transformation} from "@cloudinary/base"; + * import {Cloudinary, Transformation} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const img = yourCldInstance.image('woman'); * - * import {distortArc} from '@cloudinary/base/actions/reshape'; + * import {distortArc} from '@cloudinary/js-url-gen/actions/reshape'; * * img.reshape( * distortArc(200) @@ -90,12 +90,12 @@ function distortArc(degrees: number | string): DistortArcAction { * @return {Actions.Reshape.DistortAction} * @example *

    Distorting an image

    - * import {Cloudinary, Transformation} from "@cloudinary/base"; + * import {Cloudinary, Transformation} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const img = yourCldInstance.image('woman'); * - * import {distort} from '@cloudinary/base/actions/reshape'; + * import {distort} from '@cloudinary/js-url-gen/actions/reshape'; * * img.reshape( * distort([100, 100, 100, 200, 200, 200, 200, 100]) @@ -115,12 +115,12 @@ function distort(coordinates: IDistortCoordinates): DistortAction { * @return {Actions.Reshape.ShearAction} * @example *

    Shearing an image

    - * import {Cloudinary, Transformation} from "@cloudinary/base"; + * import {Cloudinary, Transformation} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const img = yourCldInstance.image('woman'); * - * import {shear} from '@cloudinary/base/actions/reshape'; + * import {shear} from '@cloudinary/js-url-gen/actions/reshape'; * * img.reshape( * shear(50, 0) @@ -139,12 +139,12 @@ function shear(x: stringOrNumber, y: stringOrNumber): ShearAction { * @return {Actions.Reshape.TrimAction} * @example *

    Trimming an image

    - * import {Cloudinary, Transformation} from "@cloudinary/base"; + * import {Cloudinary, Transformation} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const img = yourCldInstance.image('woman'); * - * import {trim} from '@cloudinary/base/actions/reshape'; + * import {trim} from '@cloudinary/js-url-gen/actions/reshape'; * * img.reshape( * trim().colorOverride('blue').colorSimilarity(15) diff --git a/src/actions/resize.ts b/src/actions/resize.ts index a2a32ed3..ee99e360 100644 --- a/src/actions/resize.ts +++ b/src/actions/resize.ts @@ -5,12 +5,12 @@ * @see Learn more about Gravity and Focus {@link Qualifiers.Gravity| here } * @example *

    Scaling an image

    - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); * - * const {scale, fit, pad, crop} from '@cloudinary/base/actions/resize'; + * const {scale, fit, pad, crop} from '@cloudinary/js-url-gen/actions/resize'; * * image.resize( scale(100, 100) ); * // All resize actions have a similar interface. @@ -31,13 +31,13 @@ * * @example *

    Cropping with automatic focus(Gravity)

    - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); * - * import {scale} from '@cloudinary/base/actions/resize'; - * import {autoGravity} from '@cloudinary/base/qualifiers/gravity'; + * import {scale} from '@cloudinary/js-url-gen/actions/resize'; + * import {autoGravity} from '@cloudinary/js-url-gen/qualifiers/gravity'; * * image.resize( crop(100, 100).gravity(autoGravity()) ); * diff --git a/src/actions/rotate.ts b/src/actions/rotate.ts index 880cac4a..27564885 100644 --- a/src/actions/rotate.ts +++ b/src/actions/rotate.ts @@ -5,9 +5,9 @@ * * @example * Rotate by mode - * import {Cloudinary} from "@cloudinary/base"; - * import {mode, byAngle} from "@cloudinary/base/actions/rotate"; - * import {autoLeft} from "@cloudinary/base/qualifiers/rotationMode"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {mode, byAngle} from "@cloudinary/js-url-gen/actions/rotate"; + * import {autoLeft} from "@cloudinary/js-url-gen/qualifiers/rotationMode"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/roundCorners.ts b/src/actions/roundCorners.ts index d38e8b16..a3c94621 100644 --- a/src/actions/roundCorners.ts +++ b/src/actions/roundCorners.ts @@ -8,8 +8,8 @@ * @namespace RoundCorners * @example * Round corners by a radius - * import {Cloudinary} from "@cloudinary/base"; - * import {byRadius, max} from "@cloudinary/base/actions/roundCorners"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {byRadius, max} from "@cloudinary/js-url-gen/actions/roundCorners"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/actions/transcode.ts b/src/actions/transcode.ts index 61a8ef8d..dc6312ef 100644 --- a/src/actions/transcode.ts +++ b/src/actions/transcode.ts @@ -39,9 +39,9 @@ export type ITranscodeAction = BitRateAction * Learn more: {@link https://cloudinary.com/documentation/audio_transformations#audio_frequency_control | Audio frequency control} * @param {AudioFrequencyType|string|number} freq The audio frequency. * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {FREQ11025} from '@cloudinary/base/qualifiers/audioFrequency' - * import {audioFrequency} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {FREQ11025} from '@cloudinary/js-url-gen/qualifiers/audioFrequency' + * import {audioFrequency} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -59,9 +59,9 @@ function audioFrequency(freq: AudioFrequencyType|string|number): AudioFrequencyA * @description Sets the audio codec or removes the audio channel. * @param {AudioCodecType | string} codec The audio codec or "none". * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {aac} from '@cloudinary/base/qualifiers/audioCodec' - * import {audioCodec} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {aac} from '@cloudinary/js-url-gen/qualifiers/audioCodec' + * import {audioCodec} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -86,8 +86,8 @@ function audioCodec(codec: AudioCodecType | string): AudioCodecAction{ * The value can be an integer e.g. 120000, or a string supporting "k" and "m" * (kilobits and megabits respectively) e.g. 250k or 2m. * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {bitRate} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {bitRate} from '@cloudinary/js-url-gen/actions/transcode' * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); * @@ -103,8 +103,8 @@ function bitRate(bitRate: string|number): BitRateAction { * @memberOf Actions.Transcode * @param {number} from frame rate * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {fps} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {fps} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -124,8 +124,8 @@ function fps(from: number): FPSAction { * @param {number} from frame rate * @param {number} to frame rate * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {fpsRange} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {fpsRange} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -143,8 +143,8 @@ function fpsRange(from: number, to?: number): FPSRangeAction { * @description Sets the keyframe interval of the delivered video. * @param {number | string} interval The keyframe interval in seconds. * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {keyframeInterval} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {keyframeInterval} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -165,9 +165,9 @@ function keyframeInterval(interval: number | string): KeyframeIntervalsAction { * profiles or to create new custom profiles. * @param {string} profile The streaming profile. * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {fullHd} from "@cloudinary/base/qualifiers/streamingProfile"; - * import {streamingProfile} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {fullHd} from "@cloudinary/js-url-gen/qualifiers/streamingProfile"; + * import {streamingProfile} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -185,9 +185,9 @@ function streamingProfile(profile: StreamingProfileTypes | string): StreamingPro * @description Converts a video to animated image. * @param {string | AnimatedFormatType} animatedFormat The streaming profile. * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {gif} from '@cloudinary/base/qualifiers/animatedFormat' - * import {toAnimated} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {gif} from '@cloudinary/js-url-gen/qualifiers/animatedFormat' + * import {toAnimated} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -205,9 +205,9 @@ function toAnimated(animatedFormat: AnimatedFormatQualifierValue | AnimatedForma * @description Controls the video codec. * @param {Qualifiers.VideoCodec.VideoCodecType | Qualifiers.VideoCodec.AdvVideoCodecType} videoCodecType CodecType * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {vp9} from '@cloudinary/base/qualifiers/videoCodec' - * import {videoCodec} from '@cloudinary/base/actions/transcode' + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {vp9} from '@cloudinary/js-url-gen/qualifiers/videoCodec' + * import {videoCodec} from '@cloudinary/js-url-gen/actions/transcode' * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); diff --git a/src/actions/underlay.ts b/src/actions/underlay.ts index c92fd524..bdc9ce86 100644 --- a/src/actions/underlay.ts +++ b/src/actions/underlay.ts @@ -11,14 +11,14 @@ import {FetchSource} from "../qualifiers/source/sourceTypes/FetchSource"; * @see Visit {@link Qualifiers.TextStyle|TextStyle} for advanced text options * @see {@link Actions.Overlay| The overlay action} * @example - * import {Cloudinary} from "@cloudinary/base"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const myVideo = yourCldInstance.video('dog'); * - * import {source} from "@cloudinary/base/actions/underlay" - * import {image, video, text} from "@cloudinary/base/qualifiers/source" - * import {TextStyle} from '@cloudinary/base/qualifiers/textStyle + * import {source} from "@cloudinary/js-url-gen/actions/underlay" + * import {image, video, text} from "@cloudinary/js-url-gen/qualifiers/source" + * import {TextStyle} from '@cloudinary/js-url-gen/qualifiers/textStyle * * myVideo.underlay( * source(image('myImage')) diff --git a/src/actions/variable.ts b/src/actions/variable.ts index dcb5dceb..1ff9f7ea 100644 --- a/src/actions/variable.ts +++ b/src/actions/variable.ts @@ -10,14 +10,14 @@ import {toFloatAsString} from "../internal/utils/toFloatAsString"; * @memberOf Actions * @namespace Variable * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; * import { * set, * setAssetReference, * setFromContext, * setFromMetadata - * } from "@cloudinary/base/actions/variable"; - * import {scale} from "@cloudinary/base/actions/resize"; + * } from "@cloudinary/js-url-gen/actions/variable"; + * import {scale} from "@cloudinary/js-url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * diff --git a/src/actions/videoEdit.ts b/src/actions/videoEdit.ts index d193ec65..559db397 100644 --- a/src/actions/videoEdit.ts +++ b/src/actions/videoEdit.ts @@ -25,10 +25,10 @@ import {PreviewAction} from "./videoEdit/PreviewAction"; * @param {VideoSource} source The source to concatenate. * @return {Actions.VideoEdit.ConcatenateAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {concatenate} from "@cloudinary/base/actions/videoEdit"; - * import {videoSource as concatVideoSource} from "@cloudinary/base/qualifiers/concatenate"; - * import {videoSource as tVideoSource} from "@cloudinary/base/qualifiers/transition"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {concatenate} from "@cloudinary/js-url-gen/actions/videoEdit"; + * import {videoSource as concatVideoSource} from "@cloudinary/js-url-gen/qualifiers/concatenate"; + * import {videoSource as tVideoSource} from "@cloudinary/js-url-gen/qualifiers/transition"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -52,8 +52,8 @@ function concatenate(source:VideoSource):ConcatenateAction{ * @memberOf Actions.VideoEdit * @return {Actions.VideoEdit.TrimAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {trim} from "@cloudinary/base/actions/videoEdit"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {trim} from "@cloudinary/js-url-gen/actions/videoEdit"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -80,9 +80,9 @@ function trim(): TrimAction{ * For a list of supported types see {@link Qualifiers.Volume| Volume values} * @return {Actions.VideoEdit.VolumeAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {volume} from "@cloudinary/base/actions/videoEdit"; - * import {mute} from '@cloudinary/base/qualifiers/volume'; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {volume} from "@cloudinary/js-url-gen/actions/videoEdit"; + * import {mute} from '@cloudinary/js-url-gen/qualifiers/volume'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); @@ -105,8 +105,8 @@ function volume(volumeValue: string | number): VolumeAction{ * @memberOf Actions.VideoEdit * @return {Actions.VideoEdit.PreviewAction} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {preview} from "@cloudinary/base/actions/videoEdit"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {preview} from "@cloudinary/js-url-gen/actions/videoEdit"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const video = yourCldInstance.video('dog'); diff --git a/src/config/interfaces/Config/ICloudConfig.ts b/src/config/interfaces/Config/ICloudConfig.ts index 52fd2651..f520164c 100644 --- a/src/config/interfaces/Config/ICloudConfig.ts +++ b/src/config/interfaces/Config/ICloudConfig.ts @@ -9,7 +9,7 @@ import IAuthTokenConfig from "./IAuthTokenConfig"; * @prop {string} [apiSecret] * @prop {IAuthTokenConfig} [authToken] * @example - * import Cloudinary from '@cloudinary/base'; + * import Cloudinary from '@cloudinary/js-url-gen'; * // The Cloudinary Instance accepts a CloudConfig under the `cloud` key * const cld = new Cloudinary({ * // the cloudConfig diff --git a/src/config/interfaces/Config/ICloudinaryAssetConfigurations.ts b/src/config/interfaces/Config/ICloudinaryAssetConfigurations.ts index 92127619..4e7da817 100644 --- a/src/config/interfaces/Config/ICloudinaryAssetConfigurations.ts +++ b/src/config/interfaces/Config/ICloudinaryAssetConfigurations.ts @@ -9,7 +9,7 @@ import ICloudConfig from "./ICloudConfig"; * @prop {ICloudConfig} cloud * @prop {IURLConfig} url * @example - * import Cloudinary from '@cloudinary/base'; + * import Cloudinary from '@cloudinary/js-url-gen'; * // The Cloudinary Instance accepts an ICloudinaryAssetConfigurations as an argument * // ICloudinaryAssetConfigurations is built from two parts, the `cloud` and the `url` keys. * const cld = new Cloudinary({ diff --git a/src/config/interfaces/Config/IURLConfig.ts b/src/config/interfaces/Config/IURLConfig.ts index 3f3ea1f1..a8f12bd6 100644 --- a/src/config/interfaces/Config/IURLConfig.ts +++ b/src/config/interfaces/Config/IURLConfig.ts @@ -14,7 +14,7 @@ * @prop {boolean} [forceVersion] * @prop {boolean} [analytics] * @example - * import Cloudinary from '@cloudinary/base'; + * import Cloudinary from '@cloudinary/js-url-gen'; * // The Cloudinary Instance accepts a URLConfig under the `url` key * const cld = new Cloudinary({ * // the cloudConfig diff --git a/src/package.json b/src/package.json index 45f9bf9b..a7412013 100644 --- a/src/package.json +++ b/src/package.json @@ -1,5 +1,5 @@ { - "name": "@cloudinary/base", + "name": "@cloudinary/js-url-gen", "version": "1.0.0-beta.4", "description": "", "keywords": [], @@ -12,4 +12,4 @@ "main": "./bundles/umd/base.js", "browser": "./index.js", "sideEffects": false -} \ No newline at end of file +} diff --git a/src/qualifiers/color.ts b/src/qualifiers/color.ts index 988ed942..bb760dab 100644 --- a/src/qualifiers/color.ts +++ b/src/qualifiers/color.ts @@ -5,7 +5,7 @@ * @example * // Reference only, do NOT use within your code for tree-shaking reasons * // SDK functions that require color accept a string (like 'red') or a hex value, like 'ffffff' - * import {Color} from '@cloudinary/base/qualifiers/color' + * import {Color} from '@cloudinary/js-url-gen/qualifiers/color' * console.log(Color.RED); */ diff --git a/src/qualifiers/gravity.ts b/src/qualifiers/gravity.ts index 85a791eb..b621421c 100644 --- a/src/qualifiers/gravity.ts +++ b/src/qualifiers/gravity.ts @@ -13,10 +13,10 @@ import {XYCenterGravity} from "./gravity/xyCenterGravity/XYCenterGravity"; * @param {Qualifiers.Compass} direction A compass Values * @memberOf Qualifiers.Gravity * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {compass} from "@cloudinary/base/qualifiers/gravity"; - * import {north} from "@cloudinary/base/qualifiers/compass"; - * import {crop} from "@cloudinary/base/actions/resize"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {compass} from "@cloudinary/js-url-gen/qualifiers/gravity"; + * import {north} from "@cloudinary/js-url-gen/qualifiers/compass"; + * import {crop} from "@cloudinary/js-url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); @@ -33,10 +33,10 @@ function compass(direction: CompassQualifier): CompassGravity { * @param {...Qualifier.FocusOn} args One or more objects to focus on * @memberOf Qualifiers.Gravity * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {focusOn} from "@cloudinary/base/qualifiers/gravity"; - * import {crop} from "@cloudinary/base/actions/resize"; - * import {cat} from "@cloudinary/base/qualifiers/focusOn"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {focusOn} from "@cloudinary/js-url-gen/qualifiers/gravity"; + * import {crop} from "@cloudinary/js-url-gen/actions/resize"; + * import {cat} from "@cloudinary/js-url-gen/qualifiers/focusOn"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); @@ -55,19 +55,19 @@ function focusOn(...args: FocusOnValue[]): FocusOnGravity { * @memberOf Qualifiers.Gravity * @return {Qualifiers.Gravity.AutoGravity} * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {autoGravity} from "@cloudinary/base/qualifiers/gravity"; - * import {crop} from "@cloudinary/base/actions/resize"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {autoGravity} from "@cloudinary/js-url-gen/qualifiers/gravity"; + * import {crop} from "@cloudinary/js-url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(autoGravity())) * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {autoGravity} from "@cloudinary/base/qualifiers/gravity"; - * import {crop} from "@cloudinary/base/actions/resize"; - * import {cat} from "@cloudinary/base/qualifiers/focusOn"; - * import {AutoFocus} from "@cloudinary/base/qualifiers/autoFocus"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {autoGravity} from "@cloudinary/js-url-gen/qualifiers/gravity"; + * import {crop} from "@cloudinary/js-url-gen/actions/resize"; + * import {cat} from "@cloudinary/js-url-gen/qualifiers/focusOn"; + * import {AutoFocus} from "@cloudinary/js-url-gen/qualifiers/autoFocus"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); @@ -95,10 +95,10 @@ function xyCenter(): XYCenterGravity { * @namespace Gravity * @memberOf Qualifiers * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {compass} from "@cloudinary/base/qualifiers/gravity"; - * import {north} from "@cloudinary/base/qualifiers/compass"; - * import {crop} from "@cloudinary/base/actions/resize"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {compass} from "@cloudinary/js-url-gen/qualifiers/gravity"; + * import {north} from "@cloudinary/js-url-gen/qualifiers/compass"; + * import {crop} from "@cloudinary/js-url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/qualifiers/improveMode.ts b/src/qualifiers/improveMode.ts index b4b146b4..d4c1a1b8 100644 --- a/src/qualifiers/improveMode.ts +++ b/src/qualifiers/improveMode.ts @@ -5,9 +5,9 @@ * @memberOf Qualifiers * @see To be used with an {@link Actions.Adjust.improve|Adjust Improve} * @example - * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary"; - * import {outdoor} from "@cloudinary/base/qualifiers/improveMode"; - * import {improve} from "@cloudinary/base/actions/adjust"; + * import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary"; + * import {outdoor} from "@cloudinary/js-url-gen/qualifiers/improveMode"; + * import {improve} from "@cloudinary/js-url-gen/actions/adjust"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/qualifiers/progressive.ts b/src/qualifiers/progressive.ts index e7259bee..dbfda022 100644 --- a/src/qualifiers/progressive.ts +++ b/src/qualifiers/progressive.ts @@ -4,10 +4,10 @@ * @memberOf Qualifiers * @namespace Progressive * @example - * import {Cloudinary} from "@cloudinary/base"; - * import {format} from "@cloudinary/base/actions/delivery"; - * import {jpg} from "@cloudinary/base/qualifiers/format"; - * import {steep} from "@cloudinary/base/qualifiers/progressive"; + * import {Cloudinary} from "@cloudinary/js-url-gen"; + * import {format} from "@cloudinary/js-url-gen/actions/delivery"; + * import {jpg} from "@cloudinary/js-url-gen/qualifiers/format"; + * import {steep} from "@cloudinary/js-url-gen/qualifiers/progressive"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); diff --git a/src/transformation/Transformation.ts b/src/transformation/Transformation.ts index ccfc52b3..f2f74c18 100644 --- a/src/transformation/Transformation.ts +++ b/src/transformation/Transformation.ts @@ -61,7 +61,7 @@ class Transformation { * @description Allows the injection of a raw transformation as a string into the transformation, or a Transformation instance that was previously created * @param {string | SDK.Transformation} tx * @example - * import {Transformation} from "@cloudinary/base"; + * import {Transformation} from "@cloudinary/js-url-gen"; * * const transformation = new Transformation(); * transformation.addTransformation('w_100/w_200/w_300');