/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.applib.services.ascii;

/**
 * Optional SPI to provide an equivalent identifier using only ASCII character set, for the specified feature
 * (a property, collection, action or action parameter).
 *
 * <p>
 *     The GraphQL API (viewer) may require this SPI to be implemented if any of the features use non-ASCII characters,
 *     because feature Ids are used as GraphQL (field) names.
 * </p>
 *
 * @see <a href="https://spec.graphql.org/October2021/#sec-Names">GraphQL specification</a>
 *
 * @since 2.x {@index}
 */
public interface AsciiIdentifierService {

    String asciiIdFor(String featureId);

}
