Skip to content

Commit

Permalink
enum moved to own package
Browse files Browse the repository at this point in the history
  • Loading branch information
arietrouw committed Jan 14, 2025
1 parent 061fc3e commit f61d40c
Show file tree
Hide file tree
Showing 23 changed files with 1,020 additions and 26 deletions.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@
"knip": "^5.41.1",
"reflect-metadata": "^0.2.2",
"ts-node": "^10.9.2",
"tslib": "^2.8.1",
"typedoc": "^0.27.6",
"typescript": "^5.7.2",
"vite": "^6.0.7",
Expand Down
3 changes: 2 additions & 1 deletion packages/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@
"packages/**/*"
],
"dependencies": {
"@xylabs/object": "^4.4.36",
"@xylabs/enum": "workspace:^",
"@xylabs/object": "workspace:^",
"axios": "^1.7.9"
},
"devDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/ApiStage.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { EnumValue } from '@xylabs/object'
import { Enum } from '@xylabs/object'
import type { EnumValue } from '@xylabs/enum'
import { Enum } from '@xylabs/enum'

export const ApiStage = Enum({
Beta: 'beta',
Expand Down
20 changes: 20 additions & 0 deletions packages/enum/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.*
.env
.eslintcache
.example.env
tsconfig*
rollup.config.ts
yarn.lock
**/*.spec.ts
**/*.snap

.github
docs
.pnp.*
.vscode
.yarn/*
coverage
cspell.json
node_modules
swagger.json
packages
840 changes: 840 additions & 0 deletions packages/enum/LICENSE

Large diffs are not rendered by default.

69 changes: 69 additions & 0 deletions packages/enum/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
[![logo][]](https://xylabs.com)

# @xylabs/object

[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![socket-badge][]][socket-link]

> XY Labs generalized Javascript library
## Table of Contents

- [Description](#description)
- [Install](#install)
- [Maintainers](#maintainers)
- [License](#license)
- [Credits](#credits)

## Description

Common Javascript code that is used throughout XYO projects that use React.

## Install

Using npm:

```sh
npm i --save @xylabs/object
```

Using yarn:

```sh
yarn add @xylabs/object
```

## Documentation
[Developer Reference](https://xylabs.github.io/sdk-js)

## Maintainers

- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
- [Joel Carter](https://github.com/JoelBCarter)
- [Matt Jones](https://github.com/jonesmac)
- [Jordan Trouw](https://github.com/jordantrouw)

## License

See the [LICENSE](LICENSE) file for license details

## Credits

[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[npm-badge]: https://img.shields.io/npm/v/@xylabs/enum.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/enum

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/enum
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/enum

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/enum/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/enum

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/enum
[socket-link]: https://socket.dev/npm/package/@xylabs/enum
39 changes: 39 additions & 0 deletions packages/enum/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"name": "@xylabs/enum",
"version": "4.4.36",
"description": "Primary SDK for using XYO Protocol 2.0",
"homepage": "https://xyo.network",
"bugs": {
"url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
"email": "[email protected]"
},
"repository": {
"type": "git",
"url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
},
"license": "LGPL-3.0-or-later",
"author": {
"name": "XYO Development Team",
"email": "[email protected]",
"url": "https://xyo.network"
},
"sideEffects": false,
"type": "module",
"exports": {
".": {
"types": "./dist/neutral/index.d.ts",
"default": "./dist/neutral/index.mjs"
},
"./package.json": "./package.json"
},
"module": "dist/neutral/index.mjs",
"types": "dist/neutral/index.d.ts",
"devDependencies": {
"@xylabs/ts-scripts-yarn3": "^4.2.6",
"@xylabs/tsconfig": "^4.2.6",
"typescript": "^5.7.2"
},
"publishConfig": {
"access": "public"
}
}
File renamed without changes.
1 change: 1 addition & 0 deletions packages/enum/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './Enum.ts'
5 changes: 5 additions & 0 deletions packages/enum/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"exclude": ["dist", "docs", "packages", "node_modules"],
"extends": "@xylabs/tsconfig"
}

5 changes: 5 additions & 0 deletions packages/enum/tsconfig.typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"exclude": ["**/spec/*", "**/*.spec.*", "**/packages/*", "dist"],
"extends": "./tsconfig.json"
}

5 changes: 5 additions & 0 deletions packages/enum/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["./src/index.ts"],
"tsconfig": "./tsconfig.typedoc.json"
}
10 changes: 10 additions & 0 deletions packages/enum/xy.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
const config: XyTsupConfig = {
compile: {
browser: {},
neutral: { src: true },
node: {},
},
}

export default config
2 changes: 1 addition & 1 deletion packages/forget/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { forget, ForgetPromise } from './forget.ts'
export * from './forget.ts'
4 changes: 1 addition & 3 deletions packages/geo/src/mercator/tiles/equal.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import type { MercatorTile } from '../types.ts'

const tilesEqual = (tile1: MercatorTile, tile2: MercatorTile) => {
export const tilesEqual = (tile1: MercatorTile, tile2: MercatorTile) => {
return tile1[0] === tile2[0] && tile1[1] === tile2[1] && tile1[2] === tile2[2]
}

export { tilesEqual }
4 changes: 1 addition & 3 deletions packages/geo/src/mercator/tiles/hasSiblings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@ import { tileToSiblings } from '../tile/index.ts'
import type { MercatorTile } from '../types.ts'
import { tilesHasTile } from './hasTile.ts'

const hasSiblings = (tiles: MercatorTile[], tile: MercatorTile) => {
export const hasSiblings = (tiles: MercatorTile[], tile: MercatorTile) => {
const siblings = tileToSiblings(tile)
for (const sibling of siblings) {
if (!tilesHasTile(tiles, sibling)) return false
}
return true
}

export { hasSiblings }
4 changes: 1 addition & 3 deletions packages/geo/src/mercator/tiles/hasTile.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import type { MercatorTile } from '../types.ts'
import { tilesEqual } from './equal.ts'

const tilesHasTile = (tiles: MercatorTile[], tile: MercatorTile) => {
export const tilesHasTile = (tiles: MercatorTile[], tile: MercatorTile) => {
for (const tileToCheck of tiles) {
if (tilesEqual(tileToCheck, tile)) return true
}
return false
}

export { tilesHasTile }
6 changes: 4 additions & 2 deletions packages/geo/src/mercator/tiles/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
export { tilesEqual } from './equal.ts'
export * from './equal.ts'
export * from './from/index.ts'
export { tilesHasTile } from './hasTile.ts'
export * from './hasSiblings.ts'
export * from './hasTile.ts'
export * from './hasTile.ts'
2 changes: 0 additions & 2 deletions packages/indexed-db/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@
},
"devDependencies": {
"@xylabs/ts-scripts-yarn3": "^4.2.6",
"@xylabs/tsconfig": "^4.2.6",
"@xylabs/tsconfig-dom": "^4.2.6",
"@xylabs/vitest-extended": "workspace:^",
"fake-indexeddb": "^6.0.0",
"jsdom": "^25.0.1",
"typescript": "^5.7.2",
Expand Down
1 change: 1 addition & 0 deletions packages/meta/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './html/index.ts'
export * from './lib/index.ts'
export * from './meta/index.ts'
export * from './models/index.ts'
1 change: 0 additions & 1 deletion packages/object/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ export * from './AsTypeFactory.ts'
export * from './Base.ts'
export * from './Compare.ts'
export * from './EmptyObject.ts'
export * from './Enum.ts'
export * from './globallyUnique.ts'
export * from './isObject.ts'
export * from './IsObjectFactory.ts'
Expand Down
1 change: 0 additions & 1 deletion packages/storage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
"devDependencies": {
"@xylabs/ts-scripts-yarn3": "^4.2.6",
"@xylabs/tsconfig": "^4.2.6",
"@xylabs/vitest-extended": "workspace:^",
"typescript": "^5.7.2",
"vitest": "^2.1.8"
},
Expand Down
19 changes: 13 additions & 6 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4371,7 +4371,8 @@ __metadata:
version: 0.0.0-use.local
resolution: "@xylabs/api@workspace:packages/api"
dependencies:
"@xylabs/object": "npm:^4.4.36"
"@xylabs/enum": "workspace:^"
"@xylabs/object": "workspace:^"
"@xylabs/ts-scripts-yarn3": "npm:^4.2.6"
"@xylabs/tsconfig": "npm:^4.2.6"
axios: "npm:^1.7.9"
Expand Down Expand Up @@ -4501,6 +4502,16 @@ __metadata:
languageName: unknown
linkType: soft

"@xylabs/enum@workspace:^, @xylabs/enum@workspace:packages/enum":
version: 0.0.0-use.local
resolution: "@xylabs/enum@workspace:packages/enum"
dependencies:
"@xylabs/ts-scripts-yarn3": "npm:^4.2.6"
"@xylabs/tsconfig": "npm:^4.2.6"
typescript: "npm:^5.7.2"
languageName: unknown
linkType: soft

"@xylabs/error@workspace:^, @xylabs/error@workspace:packages/error":
version: 0.0.0-use.local
resolution: "@xylabs/error@workspace:packages/error"
Expand Down Expand Up @@ -4648,9 +4659,7 @@ __metadata:
"@xylabs/object": "workspace:^"
"@xylabs/storage": "workspace:^"
"@xylabs/ts-scripts-yarn3": "npm:^4.2.6"
"@xylabs/tsconfig": "npm:^4.2.6"
"@xylabs/tsconfig-dom": "npm:^4.2.6"
"@xylabs/vitest-extended": "workspace:^"
fake-indexeddb: "npm:^6.0.0"
idb: "npm:^8.0.1"
jsdom: "npm:^25.0.1"
Expand Down Expand Up @@ -4725,7 +4734,7 @@ __metadata:
languageName: unknown
linkType: soft

"@xylabs/object@npm:^4.4.36, @xylabs/object@workspace:^, @xylabs/object@workspace:packages/object":
"@xylabs/object@workspace:^, @xylabs/object@workspace:packages/object":
version: 0.0.0-use.local
resolution: "@xylabs/object@workspace:packages/object"
dependencies:
Expand Down Expand Up @@ -4828,7 +4837,6 @@ __metadata:
knip: "npm:^5.41.1"
reflect-metadata: "npm:^0.2.2"
ts-node: "npm:^10.9.2"
tslib: "npm:^2.8.1"
typedoc: "npm:^0.27.6"
typescript: "npm:^5.7.2"
vite: "npm:^6.0.7"
Expand Down Expand Up @@ -4879,7 +4887,6 @@ __metadata:
"@xylabs/promise": "workspace:^"
"@xylabs/ts-scripts-yarn3": "npm:^4.2.6"
"@xylabs/tsconfig": "npm:^4.2.6"
"@xylabs/vitest-extended": "workspace:^"
typescript: "npm:^5.7.2"
vitest: "npm:^2.1.8"
languageName: unknown
Expand Down

0 comments on commit f61d40c

Please sign in to comment.