Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@comapeo/schema

Package Overview
Dependencies
Maintainers
0
Versions
4
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@comapeo/schema - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

dist/lib/omit.d.ts
dist/lib/omit.js
dist/proto/remoteDetectionAlert/v1.d.ts
dist/proto/remoteDetectionAlert/v1.js
dist/schema/remoteDetectionAlert.d.ts
dist/schema/remoteDetectionAlert.js

2

dist/config.d.ts

@@ -5,2 +5,3 @@ export declare const dataTypeIds: {

readonly role: "69acce0ea09b";
readonly remoteDetectionAlert: "33a966ee6c90";
readonly projectSettings: "626b45fe2942";

@@ -18,2 +19,3 @@ readonly preset: "d6aa854b7a99";

readonly role: 1;
readonly remoteDetectionAlert: 1;
readonly projectSettings: 1;

@@ -20,0 +22,0 @@ readonly preset: 1;

2

dist/config.js

@@ -5,2 +5,3 @@ export const dataTypeIds = {

role: '69acce0ea09b',
remoteDetectionAlert: '33a966ee6c90',
projectSettings: '626b45fe2942',

@@ -18,2 +19,3 @@ preset: 'd6aa854b7a99',

role: 1,
remoteDetectionAlert: 1,
projectSettings: 1,

@@ -20,0 +22,0 @@ preset: 1,

4

dist/decode.js
import { Decode } from './proto/index.js';
import { dataTypeIds, currentSchemaVersions } from './config.js';
import { convertProjectSettings, convertField, convertObservation, convertPreset, convertRole, convertDeviceInfo, convertCoreOwnership, convertIcon, convertTranslation, convertTrack, } from './lib/decode-conversions.js';
import { convertProjectSettings, convertField, convertObservation, convertPreset, convertRole, convertDeviceInfo, convertCoreOwnership, convertIcon, convertTranslation, convertTrack, convertRemoteDetectionAlert, } from './lib/decode-conversions.js';
import cenc from 'compact-encoding';

@@ -44,2 +44,4 @@ import { DATA_TYPE_ID_BYTES, SCHEMA_VERSION_BYTES } from './constants.js';

return convertTrack(message, versionObj);
case 'remoteDetectionAlert':
return convertRemoteDetectionAlert(message, versionObj);
default:

@@ -46,0 +48,0 @@ throw new ExhaustivenessError(message);

7

dist/encode.js

@@ -5,3 +5,3 @@ import { currentSchemaVersions, dataTypeIds } from './config.js';

import { Encode } from './proto/index.js';
import { convertField, convertObservation, convertPreset, convertProjectSettings, convertRole, convertDeviceInfo, convertCoreOwnership, convertIcon, convertTranslation, convertTrack, } from './lib/encode-conversions.js';
import { convertField, convertObservation, convertPreset, convertProjectSettings, convertRole, convertDeviceInfo, convertCoreOwnership, convertIcon, convertTranslation, convertTrack, convertRemoteDetectionAlert, } from './lib/encode-conversions.js';
import { ExhaustivenessError } from './lib/utils.js';

@@ -70,2 +70,7 @@ /**

}
case 'remoteDetectionAlert': {
const message = convertRemoteDetectionAlert(mapeoDoc);
protobuf = Encode[mapeoDoc.schemaName](message).finish();
break;
}
default:

@@ -72,0 +77,0 @@ throw new ExhaustivenessError(mapeoDoc);

1

dist/lib/decode-conversions.d.ts

@@ -18,2 +18,3 @@ import { type ProtoTypesWithSchemaInfo, type SchemaName, type FilterBySchemaName, type MapeoDocDecode } from '../types.js';

export declare const convertTrack: ConvertFunction<'track'>;
export declare const convertRemoteDetectionAlert: ConvertFunction<'remoteDetectionAlert'>;
export {};

64

dist/lib/decode-conversions.js

@@ -6,3 +6,5 @@ import { assert, ExhaustivenessError, getVersionId, } from './utils.js';

export const convertProjectSettings = (message, versionObj) => {
const { common, schemaVersion, defaultPresets, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, defaultPresets, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -35,3 +37,5 @@ let configMetadata;

export const convertObservation = (message, versionObj) => {
const { common, metadata, schemaVersion, ...rest } = message;
const { common, metadata,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -67,3 +71,5 @@ let presetRef;

export const convertField = (message, versionObj) => {
const { common, schemaVersion, tagKey, type, label, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, tagKey, type, label, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -92,3 +98,5 @@ ensure(tagKey, 'field', 'tagKey');

export const convertPreset = (message, versionObj) => {
const { common, schemaVersion, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -123,3 +131,5 @@ const geometry = rest.geometry.filter((geomType) => geomType !== 'UNRECOGNIZED');

export const convertRole = (message, versionObj) => {
const { common, schemaVersion, fromIndex, roleId, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, fromIndex, roleId, ...rest } = message;
ensure(roleId.length, 'role', 'roleId');

@@ -136,3 +146,5 @@ ensure(typeof fromIndex === 'number', 'role', 'fromIndex');

export const convertDeviceInfo = (message, versionObj) => {
const { common, schemaVersion, name, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -142,7 +154,8 @@ return {

...rest,
name,
};
};
export const convertCoreOwnership = (message, versionObj) => {
const { common, schemaVersion, authCoreId, configCoreId, dataCoreId, blobCoreId, blobIndexCoreId, coreSignatures, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, authCoreId, configCoreId, dataCoreId, blobCoreId, blobIndexCoreId, coreSignatures, ...rest } = message;
ensure(coreSignatures, 'coreOwnership', 'coreSignatures');

@@ -167,3 +180,5 @@ ensure(authCoreId.byteLength, 'coreOwnership', 'authCoreId');

export const convertIcon = (message, versionObj) => {
const { common, schemaVersion, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -183,3 +198,5 @@ const variants = [];

export const convertTranslation = (message, versionObj) => {
const { common, schemaVersion, propertyRef, languageCode, regionCode, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, propertyRef, languageCode, regionCode, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -203,3 +220,5 @@ ensure(message.docRef, 'translation', 'docRef');

export const convertTrack = (message, versionObj) => {
const { common, schemaVersion, ...rest } = message;
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion: _schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);

@@ -228,2 +247,25 @@ const locations = message.locations.map(convertTrackPosition);

};
export const convertRemoteDetectionAlert = (message, versionObj) => {
const { common,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
schemaVersion, ...rest } = message;
const jsonSchemaCommon = convertCommon(common, versionObj);
if (!rest.detectionDateStart) {
throw new Error('missing required detectionDateStart');
}
if (!rest.detectionDateEnd) {
throw new Error('missing required detectionDateEnd');
}
if (!rest.geometry) {
throw new Error('missing required geometry');
}
return {
...jsonSchemaCommon,
...rest,
detectionDateStart: rest.detectionDateStart,
detectionDateEnd: rest.detectionDateEnd,
metadata: convertTags(rest.metadata),
geometry: rest.geometry,
};
};
function convertIconVariant(variant) {

@@ -230,0 +272,0 @@ var _a;

1

dist/lib/encode-conversions.d.ts

@@ -19,2 +19,3 @@ import { CurrentProtoTypes } from '../proto/types.js';

export declare const convertTrack: ConvertFunction<'track'>;
export declare const convertRemoteDetectionAlert: ConvertFunction<'remoteDetectionAlert'>;
export {};

8

dist/lib/encode-conversions.js

@@ -180,2 +180,10 @@ import { ExhaustivenessError, parseVersionId } from './utils.js';

};
export const convertRemoteDetectionAlert = (mapeoDoc) => {
// TODO: should we add a check for sourceId? (so that it complies with the id format we expect?)
return {
common: convertCommon(mapeoDoc),
...mapeoDoc,
metadata: convertTags(mapeoDoc.metadata),
};
};
function convertCommon(common) {

@@ -182,0 +190,0 @@ return {

15

dist/lib/utils.js

@@ -0,1 +1,2 @@

import { omit } from './omit.js';
export function getOwn(obj, key) {

@@ -55,6 +56,12 @@ return Object.hasOwn(obj, key) ? obj[key] : undefined;

export function valueOf(doc) {
/* eslint-disable no-unused-vars */
const { docId, versionId, originalVersionId, links, forks, createdAt, updatedAt, deleted, ...rest } = doc;
/* eslint-enable no-unused-vars */
return rest;
return omit(doc, [
'docId',
'versionId',
'originalVersionId',
'links',
'forks',
'createdAt',
'updatedAt',
'deleted',
]);
}

3

dist/proto/index.d.ts
import { Translation_1 } from './translation/v1.js';
import { Track_1 } from './track/v1.js';
import { Role_1 } from './role/v1.js';
import { RemoteDetectionAlert_1 } from './remoteDetectionAlert/v1.js';
import { ProjectSettings_1 } from './projectSettings/v1.js';

@@ -15,2 +16,3 @@ import { Preset_1 } from './preset/v1.js';

role: (message: Role_1, writer?: import("protobufjs").Writer) => import("protobufjs").Writer;
remoteDetectionAlert: (message: RemoteDetectionAlert_1, writer?: import("protobufjs").Writer) => import("protobufjs").Writer;
projectSettings: (message: ProjectSettings_1, writer?: import("protobufjs").Writer) => import("protobufjs").Writer;

@@ -28,2 +30,3 @@ preset: (message: Preset_1, writer?: import("protobufjs").Writer) => import("protobufjs").Writer;

Role_1: (input: import("protobufjs").Reader | Uint8Array, length?: number) => Role_1;
RemoteDetectionAlert_1: (input: import("protobufjs").Reader | Uint8Array, length?: number) => RemoteDetectionAlert_1;
ProjectSettings_1: (input: import("protobufjs").Reader | Uint8Array, length?: number) => ProjectSettings_1;

@@ -30,0 +33,0 @@ Preset_1: (input: import("protobufjs").Reader | Uint8Array, length?: number) => Preset_1;

3

dist/proto/index.js
import { Translation_1 } from './translation/v1.js';
import { Track_1 } from './track/v1.js';
import { Role_1 } from './role/v1.js';
import { RemoteDetectionAlert_1 } from './remoteDetectionAlert/v1.js';
import { ProjectSettings_1 } from './projectSettings/v1.js';

@@ -15,2 +16,3 @@ import { Preset_1 } from './preset/v1.js';

role: Role_1.encode,
remoteDetectionAlert: RemoteDetectionAlert_1.encode,
projectSettings: ProjectSettings_1.encode,

@@ -28,2 +30,3 @@ preset: Preset_1.encode,

Role_1: Role_1.decode,
RemoteDetectionAlert_1: RemoteDetectionAlert_1.decode,
ProjectSettings_1: ProjectSettings_1.decode,

@@ -30,0 +33,0 @@ Preset_1: Preset_1.decode,

10

dist/proto/types.d.ts
import { Translation_1 } from './translation/v1.js';
import { Track_1 } from './track/v1.js';
import { Role_1 } from './role/v1.js';
import { RemoteDetectionAlert_1 } from './remoteDetectionAlert/v1.js';
import { ProjectSettings_1 } from './projectSettings/v1.js';

@@ -11,3 +12,3 @@ import { Preset_1 } from './preset/v1.js';

import { CoreOwnership_1 } from './coreOwnership/v1.js';
export type ProtoTypes = Translation_1 | Track_1 | Role_1 | ProjectSettings_1 | Preset_1 | Observation_1 | Icon_1 | Field_1 | DeviceInfo_1 | CoreOwnership_1;
export type ProtoTypes = Translation_1 | Track_1 | Role_1 | RemoteDetectionAlert_1 | ProjectSettings_1 | Preset_1 | Observation_1 | Icon_1 | Field_1 | DeviceInfo_1 | CoreOwnership_1;
/** Union of all Proto Types with schemaName and schemaVersion */

@@ -23,2 +24,5 @@ export type ProtoTypesWithSchemaInfo = (Translation_1 & {

schemaVersion: number;
}) | (RemoteDetectionAlert_1 & {
schemaName: 'remoteDetectionAlert';
schemaVersion: number;
}) | (ProjectSettings_1 & {

@@ -51,2 +55,3 @@ schemaName: 'projectSettings';

role: Role_1;
remoteDetectionAlert: RemoteDetectionAlert_1;
projectSettings: ProjectSettings_1;

@@ -63,2 +68,3 @@ preset: Preset_1;

export { Role_1 };
export { RemoteDetectionAlert_1 };
export { ProjectSettings_1 };

@@ -72,2 +78,2 @@ export { Preset_1 };

/** Union of all valid names of proto types (`${capitalizedSchemaName}_${schemaVersion}`) */
export type ProtoTypeNames = 'Translation_1' | 'Track_1' | 'Role_1' | 'ProjectSettings_1' | 'Preset_1' | 'Observation_1' | 'Icon_1' | 'Field_1' | 'DeviceInfo_1' | 'CoreOwnership_1';
export type ProtoTypeNames = 'Translation_1' | 'Track_1' | 'Role_1' | 'RemoteDetectionAlert_1' | 'ProjectSettings_1' | 'Preset_1' | 'Observation_1' | 'Icon_1' | 'Field_1' | 'DeviceInfo_1' | 'CoreOwnership_1';

2

dist/proto/types.js
import { Translation_1 } from './translation/v1.js';
import { Track_1 } from './track/v1.js';
import { Role_1 } from './role/v1.js';
import { RemoteDetectionAlert_1 } from './remoteDetectionAlert/v1.js';
import { ProjectSettings_1 } from './projectSettings/v1.js';

@@ -14,2 +15,3 @@ import { Preset_1 } from './preset/v1.js';

export { Role_1 };
export { RemoteDetectionAlert_1 };
export { ProjectSettings_1 };

@@ -16,0 +18,0 @@ export { Preset_1 };

2

dist/schema/common.d.ts

@@ -25,3 +25,3 @@ /**

*/
schemaName: "translation" | "track" | "role" | "projectSettings" | "preset" | "observation" | "icon" | "field" | "deviceInfo" | "coreOwnership";
schemaName: "translation" | "track" | "role" | "remoteDetectionAlert" | "projectSettings" | "preset" | "observation" | "icon" | "field" | "deviceInfo" | "coreOwnership";
/**

@@ -28,0 +28,0 @@ * RFC3339-formatted datetime of when the first version of the element was created

9

dist/schema/index.d.ts

@@ -5,2 +5,3 @@ import { type Common as _Common } from './common.js';

import { type Role as _Role } from './role.js';
import { type RemoteDetectionAlert as _RemoteDetectionAlert } from './remoteDetectionAlert.js';
import { type ProjectSettings as _ProjectSettings } from './projectSettings.js';

@@ -27,2 +28,6 @@ import { type Preset as _Preset } from './preset.js';

export type RoleValue = Simplify<_Role>;
/** A remote detection alert is a type of element in the map that relates to an alert (regarding an urgent event that happened on the territory) */
export type RemoteDetectionAlert = Simplify<_RemoteDetectionAlert & _Common>;
/** A remote detection alert is a type of element in the map that relates to an alert (regarding an urgent event that happened on the territory) */
export type RemoteDetectionAlertValue = Simplify<_RemoteDetectionAlert>;
export type ProjectSettings = Simplify<_ProjectSettings & _Common>;

@@ -52,4 +57,4 @@ export type ProjectSettingsValue = Simplify<_ProjectSettings>;

export type CoreOwnershipValue = Simplify<_CoreOwnership>;
export type MapeoDoc = Translation | Track | Role | ProjectSettings | Preset | Observation | Icon | Field | DeviceInfo | CoreOwnership;
export type MapeoValue = TranslationValue | TrackValue | RoleValue | ProjectSettingsValue | PresetValue | ObservationValue | IconValue | FieldValue | DeviceInfoValue | CoreOwnershipValue;
export type MapeoDoc = Translation | Track | Role | RemoteDetectionAlert | ProjectSettings | Preset | Observation | Icon | Field | DeviceInfo | CoreOwnership;
export type MapeoValue = TranslationValue | TrackValue | RoleValue | RemoteDetectionAlertValue | ProjectSettingsValue | PresetValue | ObservationValue | IconValue | FieldValue | DeviceInfoValue | CoreOwnershipValue;
export {};

2

dist/types.d.ts

@@ -5,3 +5,3 @@ import { type ProtoTypesWithSchemaInfo as AllProtoTypesWithSchemaInfo } from './proto/types.js';

/** Temporary: once we have completed this module everything should be supported */
type SupportedSchemaNames = 'projectSettings' | 'observation' | 'field' | 'preset' | 'role' | 'icon' | 'deviceInfo' | 'coreOwnership' | 'translation' | 'track';
type SupportedSchemaNames = 'projectSettings' | 'observation' | 'field' | 'preset' | 'role' | 'icon' | 'deviceInfo' | 'coreOwnership' | 'translation' | 'track' | 'remoteDetectionAlert';
export type SchemaName = Extract<keyof typeof dataTypeIds, SupportedSchemaNames>;

@@ -8,0 +8,0 @@ export type SchemaNameAll = keyof typeof dataTypeIds;

33

dist/validations.d.ts

@@ -29,3 +29,3 @@ export declare const common: typeof validate10;

}): boolean;
export declare const projectSettings: typeof validate14;
export declare const remoteDetectionAlert: typeof validate14;
declare function validate14(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {

@@ -37,4 +37,4 @@ instancePath?: string | undefined;

}): boolean;
export declare const preset: typeof validate15;
declare function validate15(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const projectSettings: typeof validate20;
declare function validate20(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -45,4 +45,4 @@ parentData: any;

}): boolean;
export declare const observation: typeof validate16;
declare function validate16(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const preset: typeof validate21;
declare function validate21(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -53,4 +53,4 @@ parentData: any;

}): boolean;
export declare const icon: typeof validate17;
declare function validate17(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const observation: typeof validate22;
declare function validate22(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -61,4 +61,4 @@ parentData: any;

}): boolean;
export declare const field: typeof validate18;
declare function validate18(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const icon: typeof validate23;
declare function validate23(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -69,4 +69,4 @@ parentData: any;

}): boolean;
export declare const deviceInfo: typeof validate19;
declare function validate19(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const field: typeof validate24;
declare function validate24(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -77,4 +77,4 @@ parentData: any;

}): boolean;
export declare const coreOwnership: typeof validate20;
declare function validate20(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
export declare const deviceInfo: typeof validate25;
declare function validate25(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;

@@ -85,2 +85,9 @@ parentData: any;

}): boolean;
export declare const coreOwnership: typeof validate26;
declare function validate26(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
instancePath?: string | undefined;
parentData: any;
parentDataProperty: any;
rootData?: any;
}): boolean;
export {};

26

package.json
{
"name": "@comapeo/schema",
"version": "1.0.0",
"version": "1.1.0",
"description": "JSON Schema and TypeScript types for CoMapeo",

@@ -20,2 +20,3 @@ "main": "dist/index.js",

"lint:buf-format": "buf format --diff --exit-code ./proto",
"lint:eslint": "eslint --cache .",
"lint:prettier": "prettier --check .",

@@ -39,2 +40,3 @@ "lint": "npm-run-all --parallel lint:*",

"@bufbuild/buf": "^1.26.1",
"@eslint/js": "^9.9.1",
"@json-schema-tools/dereferencer": "^1.6.3",

@@ -46,6 +48,7 @@ "@types/compact-encoding": "^2.15.0",

"cpy-cli": "^5.0.0",
"eslint": "^8.46.0",
"eslint": "^9.9.1",
"glob": "^10.3.3",
"globals": "^15.9.0",
"hypercore": "^10.4.1",
"json-schema-to-typescript": "^13.0.2",
"json-schema-to-typescript": "^15.0.2",
"mkdirp": "^3.0.1",

@@ -60,5 +63,7 @@ "npm-run-all": "^4.1.5",

"typedoc-plugin-markdown": "^4.2.6",
"typescript": "^5.5.4"
"typescript": "^5.5.4",
"typescript-eslint": "^8.4.0"
},
"dependencies": {
"@comapeo/geometry": "^1.0.1",
"compact-encoding": "^2.12.0",

@@ -68,15 +73,2 @@ "protobufjs": "^7.2.5",

},
"eslintConfig": {
"env": {
"commonjs": true,
"es2021": true,
"node": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
"rules": {}
},
"prettier": {

@@ -83,0 +75,0 @@ "semi": false,

dist/schemas.d.ts

Sorry, the diff of this file is too big to display

dist/schemas.js

Sorry, the diff of this file is too big to display

dist/validations.js

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc