Skip to content

Commit 69605d7

Browse files
EhespEhesp
committed
feat!: rename to image-processing-api
1 parent 6c83bf1 commit 69605d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+105
-107
lines changed

‎.github/workflows/storage-image-processing-api.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: storage-image-processing-api
1+
name: image-processing-api
22

33
on:
44
pull_request:
55
paths:
6-
- 'extensions/storage-image-processing-api/**'
7-
- '.github/workflows/storage-image-processing-api.yaml'
6+
- 'extensions/image-processing-api/**'
7+
- '.github/workflows/image-processing-api.yaml'
88

99
push:
1010
branches:
@@ -14,7 +14,7 @@ on:
1414
- '**.md'
1515

1616
env:
17-
EXTENSION_PATH: 'extensions/storage-image-processing-api'
17+
EXTENSION_PATH: 'extensions/image-processing-api'
1818

1919
jobs:
2020
e2e:

‎.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
node_modules
22
build
33
**/functions/lib/**/*.js
4-
**/extensions/storage-image-processing-api/lib/src/types/**/*.ts
4+
**/extensions/image-processing-api/lib/src/types/**/*.ts
55
package-lock.json

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ access granted to the extension.
1212

1313
> Want to install one of these? Visit each extension's linked README for installation instructions.
1414
15-
### [Image Processing API](/extensions/storage-image-processing-api)
15+
### [Image Processing API](/extensions/image-processing-api)
1616

1717
Optimize and transform images from your Cloud Storage buckets via a powerful HTTP API. Supports over 30 different image
1818
operations to optimize and manipulate your images.

‎docs.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
[
88
"Storage Image Processing Api",
99
[
10-
["Overview", "/storage-image-processing-api"],
11-
["Input", "/storage-image-processing-api/input"],
12-
["Operations", "/storage-image-processing-api/operations"],
13-
["Output", "/storage-image-processing-api/output"],
14-
["Types", "/storage-image-processing-api/types"]
10+
["Overview", "/image-processing-api"],
11+
["Input", "/image-processing-api/input"],
12+
["Operations", "/image-processing-api/operations"],
13+
["Output", "/image-processing-api/output"],
14+
["Types", "/image-processing-api/types"]
1515
]
1616
]
1717
]

‎docs/storage-image-processing-api/caching.mdx renamed to ‎docs/image-processing-api/caching.mdx

File renamed without changes.

‎docs/storage-image-processing-api/error-handling.mdx renamed to ‎docs/image-processing-api/error-handling.mdx

File renamed without changes.

‎docs/storage-image-processing-api/index.mdx renamed to ‎docs/image-processing-api/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Storage Image Processing API
22

3-
The Storage Image Processing API extension (`storage-image-processing-api`) lets you optimize and transform images in the [Cloud Storage](https://firebase.google.com/docs/storage) bucket via a powerful HTTP API. The API provides more than 30 different operations to enhance and manipulate your images, including image composition, cropping, flipping, color reduction, sharpening, filtering, and much more. See the full list of available operations in the [Operations](/operations) documentation.
3+
The Storage Image Processing API extension (`image-processing-api`) lets you optimize and transform images in the [Cloud Storage](https://firebase.google.com/docs/storage) bucket via a powerful HTTP API. The API provides more than 30 different operations to enhance and manipulate your images, including image composition, cropping, flipping, color reduction, sharpening, filtering, and much more. See the full list of available operations in the [Operations](/operations) documentation.
44

55
<video width="100%" controls muted autoPlay loop>
66
<source
@@ -17,7 +17,7 @@ To install the extension, follow the steps on the [Install Firebase Extension](h
1717
- **Firebase console:** Click the following link:
1818

1919
<a
20-
href="https://console.firebase.google.com/project/_/extensions/install?ref=invertase/storage-image-processing-api"
20+
href="https://console.firebase.google.com/project/_/extensions/install?ref=invertase/image-processing-api"
2121
target="_blank"
2222
>
2323
<img
@@ -29,7 +29,7 @@ To install the extension, follow the steps on the [Install Firebase Extension](h
2929
- **CLI:** Run the following command:
3030

3131
```bash
32-
firebase ext:install invertase/storage-image-processing-api --project=projectId-or-alias
32+
firebase ext:install invertase/image-processing-api --project=projectId-or-alias
3333
```
3434

3535
During the installation of the extension, you will be prompted to specify a number of configuration parameters:
@@ -52,7 +52,7 @@ After installation, a new Cloud Function called `process` will be added to your
5252

5353
```bash
5454
curl -X GET \
55-
https://{LOCATION}-{PROJECT_ID}.cloudfunctions.net/ext-storage-image-processing-api-handler/process?operations=...
55+
https://{LOCATION}-{PROJECT_ID}.cloudfunctions.net/ext-image-processing-api-handler/process?operations=...
5656
```
5757

5858
- **`{LOCATION}`**: The Cloud Functions location that was specified during the installation of the extension.
@@ -127,15 +127,15 @@ const operations = [
127127
];
128128

129129
const encodedOperations = encodeURIComponent(JSON.stringify(operations));
130-
const url = `https://{LOCATION}-{PROJECT_ID}.cloudfunctions.net/ext-storage-image-processing-api-handler/process?operations=${encodedOperations}`;
130+
const url = `https://{LOCATION}-{PROJECT_ID}.cloudfunctions.net/ext-image-processing-api-handler/process?operations=${encodedOperations}`;
131131
```
132132

133133
### JavaScript utility library
134134

135135
Additionally, a utility library exists to provide a fully typed interface for constructing options:
136136

137137
```ts
138-
import { builder } from '@invertase/storage-image-processing-api';
138+
import { builder } from '@invertase/image-processing-api';
139139

140140
const output = builder()
141141
.input({

‎docs/storage-image-processing-api/input.mdx renamed to ‎docs/image-processing-api/input.mdx

File renamed without changes.

‎docs/storage-image-processing-api/operations.mdx renamed to ‎docs/image-processing-api/operations.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By default, new pixels are filled with a black background. You can provide a bac
1919
| idy | Integer | ✓ | n/a |
2020
| odx | Integer | ✓ | n/a |
2121
| ody | Integer | ✓ | n/a |
22-
| interpolator | Enum([Interpolator](/storage-image-processing-api/types/interpolator)) | ✓ | n/a |
22+
| interpolator | Enum([Interpolator](/image-processing-api/types/interpolator)) | ✓ | n/a |
2323

2424
#### Example
2525

@@ -79,7 +79,7 @@ Output colourspace e.g. srgb, rgb, cmyk, lab, b-w ...
7979

8080
| Key | Type | Optional | Min Value | Max Value | Default |
8181
| ---------- | :----------------------------------------------------------------: | :------: | :-------: | :-------: | :-----: |
82-
| colorspace | Enum([Colorspace](/storage-image-processing-api/types/colorspace)) | x | n/a | n/a | n/a |
82+
| colorspace | Enum([Colorspace](/image-processing-api/types/colorspace)) | x | n/a | n/a | n/a |
8383

8484
### `Composite`
8585

@@ -92,8 +92,8 @@ If both `top` and `left` options are provided, they take precedence over `gravit
9292
| Key | Type | Optional | Min Value | Max Value | Default |
9393
| ------------- | :----------------------------------------------------------: | :------: | :-------: | :-------: | :-----: |
9494
| input | string | x | n/a | n/a | n/a |
95-
| blend | Enum([Blend](/storage-image-processing-api/types/blend)) | ✓ | n/a | n/a | over |
96-
| gravity | Enum([Gravity](/storage-image-processing-api/types/gravity)) | ✓ | n/a | n/a | n/a |
95+
| blend | Enum([Blend](/image-processing-api/types/blend)) | ✓ | n/a | n/a | over |
96+
| gravity | Enum([Gravity](/image-processing-api/types/gravity)) | ✓ | n/a | n/a | n/a |
9797
| top | Integer | ✓ | n/a | n/a | n/a |
9898
| left | Integer | ✓ | n/a | n/a | n/a |
9999
| tile | Boolean | ✓ | n/a | n/a | n/a |
@@ -407,10 +407,10 @@ How the image should be resized to fit both provided dimensions.
407407
| ------------------ | :------------------------------------------------------------------------------------------: | :------: | :-------: | :-------: | :--------: |
408408
| width | Number | ✓ | 0 | n/a | n/a |
409409
| height | Number | ✓ | 0 | n/a | n/a |
410-
| fit | Enum([OperationResizeFit](/storage-image-processing-api/types/operationResizeFit)) | ✓ | n/a | n/a | 'cover' |
411-
| position | Enum([OperationResizePosition](/storage-image-processing-api/types/operationResizePosition)) | ✓ | n/a | n/a | 'center' |
410+
| fit | Enum([OperationResizeFit](/image-processing-api/types/operationResizeFit)) | ✓ | n/a | n/a | 'cover' |
411+
| position | Enum([OperationResizePosition](/image-processing-api/types/operationResizePosition)) | ✓ | n/a | n/a | 'center' |
412412
| background | String | ✓ | n/a | n/a | '#000' |
413-
| kernel | Enum([OperationResizeKernel](/storage-image-processing-api/types/operationResizeKernel)) | ✓ | n/a | n/a | 'lanczos3' |
413+
| kernel | Enum([OperationResizeKernel](/image-processing-api/types/operationResizeKernel)) | ✓ | n/a | n/a | 'lanczos3' |
414414
| withoutEnlargement | Boolean | ✓ | n/a | n/a | false |
415415
| fastShrinkOnLoad | Boolean | ✓ | n/a | n/a | true |
416416

@@ -474,7 +474,7 @@ Separate control over the level of sharpening in "flat" and "jagged" areas is av
474474
| Key | Type | Optional | Min Value | Max Value | Default |
475475
| --------------- | :--------------------------------------------------------------: | :------: | :-------: | :-------: | :-------------: |
476476
| font | String | ✓ | 0.01 | 1000 | 30px sans-serif |
477-
| textAlign | Enum([textAlign](/storage-image-processing-api/types/textAlign)) | ✓ | n/a | n/a | n/a |
477+
| textAlign | Enum([textAlign](/image-processing-api/types/textAlign)) | ✓ | n/a | n/a | n/a |
478478
| textColor | String | ✓ | n/a | n/a | white |
479479
| backgroundColor | String | ✓ | n/a | n/a | n/a |
480480
| strokeWidth | Integer | ✓ | n/a | n/a | 0 |
@@ -484,8 +484,8 @@ Separate control over the level of sharpening in "flat" and "jagged" areas is av
484484
| borderColor | String | ✓ | n/a | n/a | black |
485485
| wrap | Boolean | ✓ | n/a | n/a | n/a |
486486
| maxWidth | Integer | ✓ | n/a | n/a | n/a |
487-
| blend | Enum([Blend](/storage-image-processing-api/types/blend)) | ✓ | n/a | n/a | 0 |
488-
| gravity | Enum([Gravity](/storage-image-processing-api/types/gravity)) | ✓ | n/a | n/a | n/a |
487+
| blend | Enum([Blend](/image-processing-api/types/blend)) | ✓ | n/a | n/a | 0 |
488+
| gravity | Enum([Gravity](/image-processing-api/types/gravity)) | ✓ | n/a | n/a | n/a |
489489
| top | Integer | ✓ | n/a | n/a | n/a |
490490
| left | Integer | ✓ | n/a | n/a | n/a |
491491

@@ -532,7 +532,7 @@ Images consisting entirely of a single colour will calculate "boring" using the
532532
| threshold | Integer | ✓ | 0 | n/a | n/a |
533533

534534
export const EXTENSION_URL =
535-
'https://europe-central2-dev-extensions-testing.cloudfunctions.net/ext-storage-image-processing-api-ri3r-handler/process';
535+
'https://europe-central2-dev-extensions-testing.cloudfunctions.net/ext-image-processing-api-ri3r-handler/process';
536536

537537
export const IMAGE_URL =
538538
'https://cdn.pixabay.com/photo/2018/04/29/01/23/skin-3358873_960_720.jpg';

‎docs/storage-image-processing-api/output.mdx renamed to ‎docs/image-processing-api/output.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ Force WebP output, otherwise attempt to use input format (optional, default true
111111
| ----------- | :------------------------------------------------------------------: | :------: | :-------: | :-------: | :----------: |
112112
| quality | Integer | ✓ | 1 | 100 | 80 |
113113
| force | Boolean | ✓ | n/a | n/a | n/a |
114-
| compression | Enum([Compression](/storage-image-processing-api/types/compression)) | ✓ | n/a | n/a | 'jpeg' |
115-
| predictor | Enum([Predictor](/storage-image-processing-api/types/Predictor)) | ✓ | n/a | n/a | 'horizontal' |
114+
| compression | Enum([Compression](/image-processing-api/types/compression)) | ✓ | n/a | n/a | 'jpeg' |
115+
| predictor | Enum([Predictor](/image-processing-api/types/Predictor)) | ✓ | n/a | n/a | 'horizontal' |
116116
| pyramid | Boolean | ✓ | n/a | n/a | n/a |
117117
| tile | Boolean | ✓ | n/a | n/a | n/a |
118118
| tileWidth | Integer | ✓ | n/a | n/a | n/a |

0 commit comments

Comments
 (0)