Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
import { InstanceSetting_Key } from "@/types/proto/api/instance_service_pb";
import { Visibility } from "@/types/proto/api/memo_service_pb";
import { UserSetting_Key } from "@/types/proto/api/user_service_pb";
export const instanceSettingNamePrefix = "instance/settings/";
export const userNamePrefix = "users/";
export const memoNamePrefix = "memos/";
export const identityProviderNamePrefix = "identity-providers/";
export const buildMemoCreatorFilter = (name: string) => {
if (!name) {
return undefined;
}
const normalizedName = name.startsWith(userNamePrefix) ? name : `${userNamePrefix}${name}`;
return `creator == ${JSON.stringify(normalizedName)}`;
};
export const extractMemoIdFromName = (name: string) => {
return name.split(memoNamePrefix).pop() || "";
};
export const extractUsernameFromName = (name: string) => {
return name.startsWith(userNamePrefix) ? name.slice(userNamePrefix.length) : name;
};
export const extractIdentityProviderUidFromName = (name: string) => {
return name.split(identityProviderNamePrefix).pop() || "";
};
// Helper function to convert InstanceSetting_Key enum value to string name
export const getInstanceSettingKeyName = (key: InstanceSetting_Key): string => {
// TypeScript enum reverse mapping: converts numeric value to string name
return InstanceSetting_Key[key];
};
// Helper function to build instance setting name from key
export const buildInstanceSettingName = (key: InstanceSetting_Key): string => {
return `${instanceSettingNamePrefix}${getInstanceSettingKeyName(key)}`;
};
// Helper function to convert UserSetting_Key enum value to string name
export const getUserSettingKeyName = (key: UserSetting_Key): string => {
// TypeScript enum reverse mapping: converts numeric value to string name
return UserSetting_Key[key];
};
// Helper function to build user setting name from username and key
export const buildUserSettingName = (username: string, key: UserSetting_Key): string => {
return `${username}/settings/${getUserSettingKeyName(key)}`;
};
// Helper function to convert Visibility enum value to string name
// Used when building filter expressions that require string enum names instead of numeric values
// Example: visibility in ["PUBLIC", "PROTECTED"] instead of visibility in ["3", "2"]
export const getVisibilityName = (visibility: Visibility): string => {
// TypeScript enum reverse mapping: converts numeric value to string name
// e.g., Visibility.PUBLIC (3) -> "PUBLIC"
const name = Visibility[visibility];
if (!name) {
console.warn(`Invalid visibility value: ${visibility}, defaulting to PUBLIC`);
return "PUBLIC";
}
return name;
};
// Namespaces an editor draft cache key by Space, so drafts never bleed across contexts.
// Memos (no Space selected) keeps the bare key it has always used.
export const spaceScopedCacheKey = (baseKey: string, spaceName?: string): string => (spaceName ? `${baseKey}:${spaceName}` : baseKey);