minca
ApiSchemasVariables

Variable: spaceProfile

const spaceProfile: object & Typed<{
  avatar?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  banner?: {
     hash: string;
     key?: string;
     mime: string;
     name?: string;
     salt?: string;
     size: number;
  };
  bio?: string;
  name?: string;
  space: string;
}>;

Defined in: packages/core/src/schemas/library/social.ts:55

How the space presents itself, as std.profile is how someone does: what apps show in place of the name its constitution was founded with, and a picture. One record per space: it names the space it is of, and onePer that gives every writer the same shared key, so changing it is editing it, and which edit stands is the versions' order, never a writer's clock. A reader takes only the one whose space is the space it is in. Who may write it is the space's grants, so the presets leave it to those who keep order (STAFF_COLLECTIONS).

Type Declaration

description

readonly description: "How the space presents itself: its name, a line about it and its picture. One per space: \"space\" is its id." = 'How the space presents itself: its name, a line about it and its picture. One per space: "space" is its id.';

name

readonly name: "std.space-profile" = 'std.space-profile';

rules

readonly rules: object;

rules.onePer

readonly onePer: readonly ["space"];

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.avatar

readonly avatar: object & object;
Type Declaration
properties
properties: object;
properties.hash
hash: object;
properties.hash.maxLength
maxLength: number = 64;
properties.hash.minLength
minLength: number = 64;
properties.hash.type
type: "string";
properties.key
key: object;
properties.key.maxLength
maxLength: number = 22;
properties.key.minLength
minLength: number = 22;
properties.key.type
type: "string";
properties.mime
mime: object;
properties.mime.maxLength
maxLength: number = max;
properties.mime.minLength?
minLength?: number = min;
properties.mime.type
type: "string";
properties.name
name: object;
properties.name.maxLength
maxLength: number = max;
properties.name.minLength?
minLength?: number = min;
properties.name.type
type: "string";
properties.salt
salt: object;
properties.salt.maxLength
maxLength: number = 22;
properties.salt.minLength
minLength: number = 22;
properties.salt.type
type: "string";
properties.size
size: object;
properties.size.minimum
minimum: number = 0;
properties.size.type
type: "integer";
required
required: readonly ["hash", "size", "mime"];
type
type: "object";
x-kind
readonly "x-kind": "file";

schema.properties.banner

readonly banner: object & object;
Type Declaration
properties
properties: object;
properties.hash
hash: object;
properties.hash.maxLength
maxLength: number = 64;
properties.hash.minLength
minLength: number = 64;
properties.hash.type
type: "string";
properties.key
key: object;
properties.key.maxLength
maxLength: number = 22;
properties.key.minLength
minLength: number = 22;
properties.key.type
type: "string";
properties.mime
mime: object;
properties.mime.maxLength
maxLength: number = max;
properties.mime.minLength?
minLength?: number = min;
properties.mime.type
type: "string";
properties.name
name: object;
properties.name.maxLength
maxLength: number = max;
properties.name.minLength?
minLength?: number = min;
properties.name.type
type: "string";
properties.salt
salt: object;
properties.salt.maxLength
maxLength: number = 22;
properties.salt.minLength
minLength: number = 22;
properties.salt.type
type: "string";
properties.size
size: object;
properties.size.minimum
minimum: number = 0;
properties.size.type
type: "integer";
required
required: readonly ["hash", "size", "mime"];
type
type: "object";
x-kind
readonly "x-kind": "file";

schema.properties.bio

readonly bio: object;

schema.properties.bio.maxLength

maxLength: number = max;

schema.properties.bio.minLength?

minLength?: number = min;

schema.properties.bio.type

type: "string";

schema.properties.name

readonly name: object;

schema.properties.name.maxLength

maxLength: number = max;

schema.properties.name.minLength?

minLength?: number = min;

schema.properties.name.type

type: "string";

schema.properties.space

readonly space: object;

schema.properties.space.description

readonly description: "The space it presents: its id" = 'The space it presents: its id';

schema.properties.space.maxLength

readonly maxLength: 256 = 256;

schema.properties.space.minLength

readonly minLength: 1 = 1;

schema.properties.space.type

readonly type: "string" = 'string';

schema.required

readonly required: readonly ["space"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Space profile" = 'Space profile';

On this page

Type Declarationdescriptionnamerulesrules.onePerschemaschema.propertiesschema.properties.avatarType Declarationpropertiesproperties.hashproperties.hash.maxLengthproperties.hash.minLengthproperties.hash.typeproperties.keyproperties.key.maxLengthproperties.key.minLengthproperties.key.typeproperties.mimeproperties.mime.maxLengthproperties.mime.minLength?properties.mime.typeproperties.nameproperties.name.maxLengthproperties.name.minLength?properties.name.typeproperties.saltproperties.salt.maxLengthproperties.salt.minLengthproperties.salt.typeproperties.sizeproperties.size.minimumproperties.size.typerequiredtypex-kindschema.properties.bannerType Declarationpropertiesproperties.hashproperties.hash.maxLengthproperties.hash.minLengthproperties.hash.typeproperties.keyproperties.key.maxLengthproperties.key.minLengthproperties.key.typeproperties.mimeproperties.mime.maxLengthproperties.mime.minLength?properties.mime.typeproperties.nameproperties.name.maxLengthproperties.name.minLength?properties.name.typeproperties.saltproperties.salt.maxLengthproperties.salt.minLengthproperties.salt.typeproperties.sizeproperties.size.minimumproperties.size.typerequiredtypex-kindschema.properties.bioschema.properties.bio.maxLengthschema.properties.bio.minLength?schema.properties.bio.typeschema.properties.nameschema.properties.name.maxLengthschema.properties.name.minLength?schema.properties.name.typeschema.properties.spaceschema.properties.space.descriptionschema.properties.space.maxLengthschema.properties.space.minLengthschema.properties.space.typeschema.requiredschema.typetitle