chores: update docs

Author: Maya Shavin

docs/url-docs/content/en/examples/advanced.md

@@ -17,20 +17,24 @@ And display it as `200x200` in size, round and auto-cropping avatar:
 
 ```js
 import { setConfig, buildImageUrl } from 'cloudinary-build-url'
+import { STORAGE_TYPES, RESIZE_TYPES, Gravity } from '@cld-apis/utils'
 
 setConfig({
   cloudName: 'your-cloud-name',
 })
 
 const url = buildImageUrl('paste-the-copied-path', {
+  cloud: {
+    storageType: STORAGE_TYPES.FETCH
+  },
   transformations: {
     resize: {
-      type: 'fill',
+      type: RESIZE_TYPES.FILL,
       width: 200,
       height: 200,
     },
     radius: 'max',
-    gravity: 'auto:subject'
+    gravity: Gravity.Subject
   }
 })
 ```

docs/url-docs/content/en/examples/basic.md

@@ -25,19 +25,20 @@ You can easily generate a version of your image as a `200x200` in size, round an
 
 ```js
 import { buildImageUrl } from 'cloudinary-build-url'
+import { RESIZE_TYPES, Gravity } from '@cld-apis/utils'
 
 const url = buildImageUrl('paste-the-copied-path', {
   cloud: {
     cloudName: 'your-cloud-name',
   },
   transformations: {
     resize: {
-      type: 'fill',
+      type: RESIZE_TYPES.FILL,
       width: 200,
       height: 200,
     },
     radius: 'max',
-    gravity: 'auto:subject'
+    gravity: Gravity.Subject
   }
 })
 ```

docs/url-docs/content/en/transformations/image.md

@@ -19,7 +19,6 @@ For more detailed information on each transformation, see [Cloudinary Image tran
 
 - Type: `Border`
   - `width`: `string` | `number`
-  - `type`: `string`. Default: `solid`
   - `color`: `string`. Default: `black`
 
 Add border around the desired asset.
@@ -33,7 +32,6 @@ const url = buildImageUrl("example", {
   },
   transformations: {
     border: {
-      type: "solid",
       color: "red",
       width: 2,
     },

docs/url-docs/content/en/usage/transformer.md

@@ -8,7 +8,7 @@ version: 1
 
 In addition to the build URL API, the package exposes an instance of `Transformer`, which can be used to calculate transformations independently.
 
-## `Transformer.transform(options)`
+## `transform(options)`
 
 * `options`:
   * Type: `TransformerOption`
@@ -42,7 +42,7 @@ console.log(transArr)
 
 See [Transformations](/transformations/basic) for more details on accepted properties for `options`.
 
-## `Transformer.toString(transformations)`
+## `toString(transformations)`
 
 * `transformations`:
   * Type: `Transformation`

docs/url-docs/content/en/utils/constants.md

@@ -0,0 +1,95 @@
+---
+title: Constants
+description: 'Available constants for transformations and Cloudinary APIs'
+position: 14
+category: "@cld-apis/utils"
+version: 1
+---
+
+To make it easier to use Cloudinary transformations, `@cld-apis/utils` provides a set of constants of common-use variables, and pre-defined values for specific transformations.
+
+## `RESOURCE_TYPES`
+
+Available types of resource for uploading in Cloudinary.
+
+## `STORAGE_TYPES`
+
+Storage/Delivery type of the asset stored in Cloudinary.
+
+## `RESIZE_TYPES`
+
+All the accepted cropping types when resizing an image/video.
+
+## `ROTATION_MODES`
+
+Available pre-defined modes for rotating an image/video.
+
+## Effects
+
+Pre-defined effects for transformations.
+
+### `ArtisticFilters`
+
+A set of accepted artistic filters when `effect.name` is `art`.
+
+```js
+import { ArtisticFilters } from '@cld-apis/utils'
+import { buildImageUrl } from 'cloudinary-build-url'
+
+const src = buildImageUrl('example', {
+  transformations: {
+    effect: {
+      name: 'art',
+      value: ArtisticFilters.Aurora
+    }
+  }
+})
+```
+
+### `BlurEffects`
+
+Available blur effects for `effect.name`.
+
+### `PixelateEffects`
+
+Available pixelate effects for `effect.name`.
+
+### `Colorblind`
+
+Available colorblind effects for `effect.name` to support a11y (accessibility).
+
+### `Brightness`
+
+Available brightness effects for `effect.name`.
+
+### `Contrast`
+
+Available contrast effects for `effect.name`.
+
+### `ColorChannel`
+
+Available color modification for effect.
+
+### `ColorFilter`
+
+Available color filtering effects.
+
+### `ColorAdjustment`
+
+Available color adjustment effects.
+
+## Flags
+
+Available flags to use with `flags`.
+
+## Gravity
+
+Available pre-defined gravity position for cropping, focusing using smart AI.
+
+## Compass
+
+Available pre-defined focusing direction for resizing images.
+
+## NamedColors
+
+Named colors that can be accepted for Cloudinary color transformations.

docs/url-docs/content/en/utils/methods.md

@@ -0,0 +1,47 @@
+---
+title: Methods
+description: 'Helper methods for Cloudinary APIs'
+position: 15
+category: "@cld-apis/utils"
+version: 1
+---
+
+`@cld-apis/utils` provides a set of common methods to help using Cloudinary APIs, or being used in between different Cloudinary APIs.
+
+### toSnakeCase(obj)
+
+* `obj` - `Object`
+
+Returns a new object whose properties' names are converted to *snake_case*.
+
+```js
+
+import { toSnakeCase } from '@cld-apis/utils'
+
+const obj = toSnakeCase({
+  cloudName: '123',
+  myCamelCase: 'myCamelCase',
+})
+
+console.log(obj)
+// { cloud_name: '123', my_camel_case: 'myCamelCase' }
+```
+
+### colorify(color, prefix)
+
+* `color`
+  * Type: `String`
+  * `required`
+  * A valid CSS color string (named color, 3-4 digit HEX color or 6-8 digit for RGBA color)
+* `prefix`
+  * Type: `String`
+  * Default: `rgb:`
+
+Returns a converted color string with the prefix if needed. By default it returns the color mapped according to Cloudinary standards for color transformation.
+
+```js
+
+import { colorify } from '@cld-apis/utils'
+
+console.log(colorify('#ffffff')) // rgb:ffffff
+```

docs/url-docs/content/en/utils/setup.md

@@ -0,0 +1,27 @@
+---
+title: Setup
+description: 'How to set up utilities for Cloudinary APIs'
+position: 13
+category: "@cld-apis/utils"
+version: 1
+---
+## Installation
+
+Add `@cld-apis/utils` dependency to your project:
+
+<code-group>
+  <code-block label="Yarn" active>
+
+  ```bash
+  yarn add @cld-apis/utils
+  ```
+
+  </code-block>
+  <code-block label="NPM">
+
+  ```bash
+  npm install @cld-apis/utils
+  ```
+
+  </code-block>
+</code-group>