Switched to new dependent package name

- ass-storage-engine is now known as Papito
pull/65/head
tycrek 3 years ago
parent b6d6ba558b
commit cfa6574555
No known key found for this signature in database
GPG Key ID: 25D74F3943625263

@ -72,9 +72,9 @@ ass was designed with developers in mind. If you are a developer & want somethin
- **Multiple file storage methods** - **Multiple file storage methods**
- Local file system - Local file system
- Amazon S3, including [DigitalOcean Spaces] - Amazon S3, including [DigitalOcean Spaces]
- **Multiple data storage methods** using [ass StorageEngines] - **Multiple data storage methods** using [data engines]
- **File** - **File**
- JSON (default, [ass-storage-engine]) - JSON (default, [papito])
- YAML (soon) - YAML (soon)
- **Database** - **Database**
- PostgreSQL ([ass-psql]) - PostgreSQL ([ass-psql])
@ -84,8 +84,8 @@ ass was designed with developers in mind. If you are a developer & want somethin
[Git Submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules [Git Submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[ZWS]: https://zws.im [ZWS]: https://zws.im
[DigitalOcean Spaces]: https://www.digitalocean.com/products/spaces/ [DigitalOcean Spaces]: https://www.digitalocean.com/products/spaces/
[ass StorageEngines]: #storageengines [data engines]: #data-engines
[ass-storage-engine]: https://github.com/tycrek/ass-storage-engine [papito]: https://github.com/tycrek/papito
[ass-psql]: https://github.com/tycrek/ass-psql [ass-psql]: https://github.com/tycrek/ass-psql
[Flameshot]: https://flameshot.org/ [Flameshot]: https://flameshot.org/
[script for ass]: #flameshot-users-linux [script for ass]: #flameshot-users-linux
@ -318,23 +318,23 @@ ass is intended to provide a strong backend for developers to build their own fr
[Express.js router]: https://expressjs.com/en/guide/routing.html#express-router [Express.js router]: https://expressjs.com/en/guide/routing.html#express-router
[ctw1]: https://github.com/tycrek/ass/wiki/Writing-a-custom-frontend [ctw1]: https://github.com/tycrek/ass/wiki/Writing-a-custom-frontend
## StorageEngines ## Data Engines
[StorageEngines] are responsible for managing your data. "Data" has two parts: an identifier & the actual data itself. With ass, the data is a JSON object representing the uploaded resource. The identifier is the unique ID in the URL returned to the user on upload. [Papito data engines] are responsible for managing your data. "Data" has two parts: an identifier & the actual data itself. With ass, the data is a JSON object representing the uploaded resource. The identifier is the unique ID in the URL returned to the user on upload.
[StorageEngines]: https://github.com/tycrek/ass-storage-engine [Papito data engines]: https://github.com/tycrek/papito
**Supported StorageEngines:** **Supported data engines:**
| Name | Description | Links | | Name | Description | Links |
| :--: | ----------- | :---: | | :--: | ----------- | :---: |
| **JSON** | JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a [Map]. This is the default StorageEngine. | [GitHub][GH ASE]<br>[NPM][NPM ASE] | | **JSON** | JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a [Map]. This is the default engine. | [GitHub][GH ASE]<br>[NPM][NPM ASE] |
| **PostgreSQL** | Data storage using a [PostgreSQL] database. [node-postgres] is used for communicating with the database. | [GitHub][GH APSQL]<br>[NPM][NPM APSQL] | | **PostgreSQL** | Data storage using a [PostgreSQL] database. [node-postgres] is used for communicating with the database. | [GitHub][GH APSQL]<br>[NPM][NPM APSQL] |
| **Mongoose** | Data storage using a [MongoDB] database. [mongoose] is used for communicating with the database. Created by [@dylancl] | [GitHub][GH AMongoose]<br>[NPM][NPM AMongoose] | | **Mongoose** | Data storage using a [MongoDB] database. [mongoose] is used for communicating with the database. Created by [@dylancl] | [GitHub][GH AMongoose]<br>[NPM][NPM AMongoose] |
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map [Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
[GH ASE]: https://github.com/tycrek/ass-storage-engine/ [GH ASE]: https://github.com/tycrek/papito/
[NPM ASE]: https://www.npmjs.com/package/@tycrek/ass-storage-engine [NPM ASE]: https://www.npmjs.com/package/@tycrek/papito
[PostgreSQL]: https://www.postgresql.org/ [PostgreSQL]: https://www.postgresql.org/
[node-postgres]: https://node-postgres.com/ [node-postgres]: https://node-postgres.com/
[GH APSQL]: https://github.com/tycrek/ass-psql/ [GH APSQL]: https://github.com/tycrek/ass-psql/
@ -345,17 +345,17 @@ ass is intended to provide a strong backend for developers to build their own fr
[NPM AMongoose]: https://www.npmjs.com/package/ass-mongoose [NPM AMongoose]: https://www.npmjs.com/package/ass-mongoose
[@dylancl]: https://github.com/dylancl [@dylancl]: https://github.com/dylancl
An ass StorageEngine implements support for one type of database (or file, such as JSON or YAML). This lets ass server hosts pick their database of choice, because all they'll have to do is enter the connection/authentication details, and ass will handle the rest, using the resource ID as the key. A Papito data engine implements support for one type of database (or file, such as JSON or YAML). This lets ass server hosts pick their database of choice, because all they'll have to do is enter the connection/authentication details, and ass will handle the rest, using the resource ID as the key.
The only StorageEngine ass comes with by default is **JSON**. If you find or create a StorageEngine you like, you can use it by installing it with `npm i <package-name>` then changing the contents of [`data.js`]. The StorageEngines own README file should also instruct how to use it. At this time, a modified `data.js` might look like this: The only engine ass comes with by default is **JSON**. If you find or create an engine you like, you can use it by installing it with `npm i <package-name>` then changing the contents of [`data.js`]. The engines own README file should also instruct how to use it. At this time, a modified `data.js` might look like this:
```js ```js
/** /**
* Used for global data management * Used for global data management
*/ */
//const { JsonStorageEngine } = require('@tycrek/ass-storage-engine'); //const { JsonStorageEngine } = require('@tycrek/papito');
const { CustomStorageEngine } = require('my-custom-ass-storage-engine'); const { CustomStorageEngine } = require('my-custom-papito');
//const data = new JsonStorageEngine(); //const data = new JsonStorageEngine();
@ -372,17 +372,13 @@ module.exports = data1;
``` ```
As long as the StorageEngine properly implements `GET`/`PUT`/`DEL`/`HAS` StorageFunctions, replacing the file/database system is just that easy. As long as the engine properly implements `GET`/`PUT`/`DEL`/`HAS` StorageFunctions, replacing the file/database system is just that easy.
**For a detailed walkthrough on developing StorageEngines, [consult the wiki][ctw2].** **For a detailed walkthrough on developing engines, [consult the wiki][ctw2].**
[`data.js`]: https://github.com/tycrek/ass/blob/master/data.js [`data.js`]: https://github.com/tycrek/ass/blob/master/data.js
[ctw2]: https://github.com/tycrek/ass/wiki/Writing-a-StorageEngine [ctw2]: https://github.com/tycrek/ass/wiki/Writing-a-StorageEngine
#### But why not "DataEngine"?
Because I was dumb & didn't know what to call it, totally forgetting that "storage engine" would also imply a way to store *files*, not just *data*.
## npm scripts ## npm scripts
ass has a number of pre-made npm scripts for you to use. **All** of these scripts should be run using `npm run <script-name>` (except `start`). ass has a number of pre-made npm scripts for you to use. **All** of these scripts should be run using `npm run <script-name>` (except `start`).

@ -92,7 +92,7 @@ app.use((err, _req, res, _next) => log.error(err).err(err).callback(() => res.se
log log
.info('Users', `${Object.keys(users).length}`) .info('Users', `${Object.keys(users).length}`)
.info('Files', `${data.size}`) .info('Files', `${data.size}`)
.info('StorageEngine', data.name, data.type) .info('Data engine', data.name, data.type)
.info('Frontend', ASS_FRONTEND.enabled ? ASS_FRONTEND.brand : 'disabled', `${ASS_FRONTEND.enabled ? `${getTrueHttp()}${getTrueDomain()}${ASS_FRONTEND.endpoint}` : ''}`) .info('Frontend', ASS_FRONTEND.enabled ? ASS_FRONTEND.brand : 'disabled', `${ASS_FRONTEND.enabled ? `${getTrueHttp()}${getTrueDomain()}${ASS_FRONTEND.endpoint}` : ''}`)
.info('Custom index', ASS_INDEX ? `enabled` : 'disabled') .info('Custom index', ASS_INDEX ? `enabled` : 'disabled')
.blank() .blank()

@ -2,6 +2,6 @@
* Used for global data management * Used for global data management
*/ */
const { JsonStorageEngine } = require('@tycrek/ass-storage-engine'); const { JsonStorageEngine } = require('@tycrek/papito');
const data = new JsonStorageEngine(); const data = new JsonStorageEngine();
module.exports = data; module.exports = data;

100
package-lock.json generated

@ -9,10 +9,10 @@
"version": "0.8.6", "version": "0.8.6",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"@tycrek/ass-storage-engine": "^0.2.7",
"@tycrek/express-nofavicon": "^1.0.2", "@tycrek/express-nofavicon": "^1.0.2",
"@tycrek/isprod": "^2.0.2", "@tycrek/isprod": "^2.0.2",
"@tycrek/log": ">=0.5.x", "@tycrek/log": ">=0.5.x",
"@tycrek/papito": "^0.3.0",
"any-shell-escape": "^0.1.1", "any-shell-escape": "^0.1.1",
"aws-sdk": "^2.930.0", "aws-sdk": "^2.930.0",
"check-node-version": "^4.1.0", "check-node-version": "^4.1.0",
@ -564,35 +564,6 @@
"regenerator-runtime": "^0.13.3" "regenerator-runtime": "^0.13.3"
} }
}, },
"node_modules/@tycrek/ass-storage-engine": {
"version": "0.2.7",
"resolved": "https://registry.npmjs.org/@tycrek/ass-storage-engine/-/ass-storage-engine-0.2.7.tgz",
"integrity": "sha512-bNgUVu4zw2zFGmIL/vZTpwYWX2P+tvAHVwlrtBkIYFH1BIEmpTVYw5mnsu0xYKZU10HbAeKTclBz2lOynIQHFA==",
"dependencies": {
"fs-extra": "^10.0.0"
},
"engines": {
"node": ">=14.x.x",
"npm": ">=7.x.x"
},
"funding": {
"type": "patreon",
"url": "https://patreon.com/tycrek"
}
},
"node_modules/@tycrek/ass-storage-engine/node_modules/fs-extra": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
"integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
"dependencies": {
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
},
"engines": {
"node": ">=12"
}
},
"node_modules/@tycrek/express-nofavicon": { "node_modules/@tycrek/express-nofavicon": {
"version": "1.0.3", "version": "1.0.3",
"resolved": "https://registry.npmjs.org/@tycrek/express-nofavicon/-/express-nofavicon-1.0.3.tgz", "resolved": "https://registry.npmjs.org/@tycrek/express-nofavicon/-/express-nofavicon-1.0.3.tgz",
@ -626,6 +597,35 @@
"url": "https://patreon.com/tycrek" "url": "https://patreon.com/tycrek"
} }
}, },
"node_modules/@tycrek/papito": {
"version": "0.3.0",
"resolved": "https://registry.npmjs.org/@tycrek/papito/-/papito-0.3.0.tgz",
"integrity": "sha512-zXZHvuTPLiW+eL30VeohnqNOdnZR1OfrxJef3Eb/SWHDOwKbX3V4Zdx3HlJp40ZQfM32M5sDlURR4KsGbTgRAQ==",
"dependencies": {
"fs-extra": "^10.0.0"
},
"engines": {
"node": ">=14.x.x",
"npm": ">=7.x.x"
},
"funding": {
"type": "patreon",
"url": "https://patreon.com/tycrek"
}
},
"node_modules/@tycrek/papito/node_modules/fs-extra": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
"integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
"dependencies": {
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
},
"engines": {
"node": ">=12"
}
},
"node_modules/@types/node": { "node_modules/@types/node": {
"version": "10.17.60", "version": "10.17.60",
"resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz",
@ -4087,26 +4087,6 @@
"regenerator-runtime": "^0.13.3" "regenerator-runtime": "^0.13.3"
} }
}, },
"@tycrek/ass-storage-engine": {
"version": "0.2.7",
"resolved": "https://registry.npmjs.org/@tycrek/ass-storage-engine/-/ass-storage-engine-0.2.7.tgz",
"integrity": "sha512-bNgUVu4zw2zFGmIL/vZTpwYWX2P+tvAHVwlrtBkIYFH1BIEmpTVYw5mnsu0xYKZU10HbAeKTclBz2lOynIQHFA==",
"requires": {
"fs-extra": "^10.0.0"
},
"dependencies": {
"fs-extra": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
"integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
"requires": {
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
}
}
}
},
"@tycrek/express-nofavicon": { "@tycrek/express-nofavicon": {
"version": "1.0.3", "version": "1.0.3",
"resolved": "https://registry.npmjs.org/@tycrek/express-nofavicon/-/express-nofavicon-1.0.3.tgz", "resolved": "https://registry.npmjs.org/@tycrek/express-nofavicon/-/express-nofavicon-1.0.3.tgz",
@ -4128,6 +4108,26 @@
"use-climate-change-reminder": "^0.0.7" "use-climate-change-reminder": "^0.0.7"
} }
}, },
"@tycrek/papito": {
"version": "0.3.0",
"resolved": "https://registry.npmjs.org/@tycrek/papito/-/papito-0.3.0.tgz",
"integrity": "sha512-zXZHvuTPLiW+eL30VeohnqNOdnZR1OfrxJef3Eb/SWHDOwKbX3V4Zdx3HlJp40ZQfM32M5sDlURR4KsGbTgRAQ==",
"requires": {
"fs-extra": "^10.0.0"
},
"dependencies": {
"fs-extra": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
"integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
"requires": {
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
}
}
}
},
"@types/node": { "@types/node": {
"version": "10.17.60", "version": "10.17.60",
"resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz",

@ -35,10 +35,10 @@
"url": "https://patreon.com/tycrek" "url": "https://patreon.com/tycrek"
}, },
"dependencies": { "dependencies": {
"@tycrek/ass-storage-engine": "^0.2.7",
"@tycrek/express-nofavicon": "^1.0.2", "@tycrek/express-nofavicon": "^1.0.2",
"@tycrek/isprod": "^2.0.2", "@tycrek/isprod": "^2.0.2",
"@tycrek/log": ">=0.5.x", "@tycrek/log": ">=0.5.x",
"@tycrek/papito": "^0.3.0",
"any-shell-escape": "^0.1.1", "any-shell-escape": "^0.1.1",
"aws-sdk": "^2.930.0", "aws-sdk": "^2.930.0",
"check-node-version": "^4.1.0", "check-node-version": "^4.1.0",
@ -63,4 +63,4 @@
"submodule": "^1.2.1", "submodule": "^1.2.1",
"uuid": "^8.3.2" "uuid": "^8.3.2"
} }
} }

Loading…
Cancel
Save